Video Stitcher V1 API - Class Google::Cloud::Video::Stitcher::V1::LiveSession (v0.3.0)

Version 0.3.0

• 0.9.0 (latest)
• 0.8.2
• 0.7.0
• 0.6.2
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Video Stitcher V1 API class Google::Cloud::Video::Stitcher::V1::LiveSession.

Metadata for a live session.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#ad_tag_macros

def ad_tag_macros() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI. Macros are designated by square brackets.

  For example:

  Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"

  Ad tag macros: {"geoId": "123"}

  Fully qualified ad tag: "https://doubleclick.google.com/ad/1?geo_id=123"

#ad_tag_macros=

def ad_tag_macros=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI. Macros are designated by square brackets.

  For example:

  Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"

  Ad tag macros: {"geoId": "123"}

  Fully qualified ad tag: "https://doubleclick.google.com/ad/1?geo_id=123"

Returns

• (::Google::Protobuf::Map{::String => ::String}) — Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI. Macros are designated by square brackets.

  For example:

  Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"

  Ad tag macros: {"geoId": "123"}

  Fully qualified ad tag: "https://doubleclick.google.com/ad/1?geo_id=123"

#ad_tag_map

def ad_tag_map() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Video::Stitcher::V1::AdTag}

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::Video::Stitcher::V1::AdTag}) — Key value pairs for ad tags. Ads parsed from ad tags must be MP4 videos each with at least one audio track.

#ad_tag_map=

def ad_tag_map=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Video::Stitcher::V1::AdTag}

Parameter

• value (::Google::Protobuf::Map{::String => ::Google::Cloud::Video::Stitcher::V1::AdTag}) — Key value pairs for ad tags. Ads parsed from ad tags must be MP4 videos each with at least one audio track.

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::Video::Stitcher::V1::AdTag}) — Key value pairs for ad tags. Ads parsed from ad tags must be MP4 videos each with at least one audio track.

#client_ad_tracking

def client_ad_tracking() -> ::Boolean

Returns

• (::Boolean) — Whether client side ad tracking is enabled. If enabled, the client player is expected to trigger playback and activity events itself. Otherwise, server side ad tracking is enabled and the Video Stitcher API will trigger playback events on behalf of the client player.

#client_ad_tracking=

def client_ad_tracking=(value) -> ::Boolean

Parameter

• value (::Boolean) — Whether client side ad tracking is enabled. If enabled, the client player is expected to trigger playback and activity events itself. Otherwise, server side ad tracking is enabled and the Video Stitcher API will trigger playback events on behalf of the client player.

Returns

• (::Boolean) — Whether client side ad tracking is enabled. If enabled, the client player is expected to trigger playback and activity events itself. Otherwise, server side ad tracking is enabled and the Video Stitcher API will trigger playback events on behalf of the client player.

#default_ad_tag_id

def default_ad_tag_id() -> ::String

Returns

• (::String) — The default ad tag to use when no ad tag ids are specified in an ad break's SCTE-35 message.

  default_ad_tag_id is necessary when adTagMap has more than one key. Its value must be present in the adTagMap.

#default_ad_tag_id=

def default_ad_tag_id=(value) -> ::String

Parameter

• value (::String) — The default ad tag to use when no ad tag ids are specified in an ad break's SCTE-35 message.

  default_ad_tag_id is necessary when adTagMap has more than one key. Its value must be present in the adTagMap.

Returns

• (::String) — The default ad tag to use when no ad tag ids are specified in an ad break's SCTE-35 message.

  default_ad_tag_id is necessary when adTagMap has more than one key. Its value must be present in the adTagMap.

#default_slate_id

def default_slate_id() -> ::String

Returns

• (::String) — The default slate to use when no slates are specified in an ad break's SCTE-35 message. When specified, this value must match the ID for a slate that has already been created via the CreateSlate method.

#default_slate_id=

def default_slate_id=(value) -> ::String

Parameter

• value (::String) — The default slate to use when no slates are specified in an ad break's SCTE-35 message. When specified, this value must match the ID for a slate that has already been created via the CreateSlate method.

Returns

• (::String) — The default slate to use when no slates are specified in an ad break's SCTE-35 message. When specified, this value must match the ID for a slate that has already been created via the CreateSlate method.

#manifest_options

def manifest_options() -> ::Google::Cloud::Video::Stitcher::V1::ManifestOptions

Returns

• (::Google::Cloud::Video::Stitcher::V1::ManifestOptions) — Additional options that affect the output of the manifest.

#manifest_options=

def manifest_options=(value) -> ::Google::Cloud::Video::Stitcher::V1::ManifestOptions

Parameter

• value (::Google::Cloud::Video::Stitcher::V1::ManifestOptions) — Additional options that affect the output of the manifest.

Returns

• (::Google::Cloud::Video::Stitcher::V1::ManifestOptions) — Additional options that affect the output of the manifest.

#name

def name() -> ::String

Returns

• (::String) — Output only. The name of the live session, in the form of projects/{project}/locations/{location}/liveSessions/{id}.

#play_uri

def play_uri() -> ::String

Returns

• (::String) — Output only. The URI to play the live session's ad-stitched stream.

#source_uri

def source_uri() -> ::String

Returns

• (::String) — The URI of the live session's source stream.

#source_uri=

def source_uri=(value) -> ::String

Parameter

• value (::String) — The URI of the live session's source stream.

Returns

• (::String) — The URI of the live session's source stream.

#stitching_policy

def stitching_policy() -> ::Google::Cloud::Video::Stitcher::V1::LiveSession::StitchingPolicy

Returns

• (::Google::Cloud::Video::Stitcher::V1::LiveSession::StitchingPolicy) — Defines the stitcher behavior in case an ad does not align exactly with the ad break boundaries. If not specified, the default is COMPLETE_AD.

#stitching_policy=

def stitching_policy=(value) -> ::Google::Cloud::Video::Stitcher::V1::LiveSession::StitchingPolicy

Parameter

• value (::Google::Cloud::Video::Stitcher::V1::LiveSession::StitchingPolicy) — Defines the stitcher behavior in case an ad does not align exactly with the ad break boundaries. If not specified, the default is COMPLETE_AD.

Returns

• (::Google::Cloud::Video::Stitcher::V1::LiveSession::StitchingPolicy) — Defines the stitcher behavior in case an ad does not align exactly with the ad break boundaries. If not specified, the default is COMPLETE_AD.

#stream_id

def stream_id() -> ::String

Returns

• (::String) — Output only. The generated ID of the LiveSession's source stream.