Video Stitcher V1 API - Class Google::Cloud::Video::Stitcher::V1::LiveSession (v1.0.1)

Version 1.0.1

• 1.1.0 (latest)
• 1.0.1
• 0.10.0
• 0.9.0
• 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. The session expires 5 minutes after the client stops fetching the session's playlists.

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, only available for live sessions that do not implement Google Ad manager ad insertion. 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, only available for live sessions that do not implement Google Ad manager ad insertion. 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, only available for live sessions that do not implement Google Ad manager ad insertion. 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_tracking

def ad_tracking() -> ::Google::Cloud::Video::Stitcher::V1::AdTracking

Returns

• (::Google::Cloud::Video::Stitcher::V1::AdTracking) — Determines how the ad should be tracked. This overrides the value set in the live config for this session.

#ad_tracking=

def ad_tracking=(value) -> ::Google::Cloud::Video::Stitcher::V1::AdTracking

Parameter

• value (::Google::Cloud::Video::Stitcher::V1::AdTracking) — Determines how the ad should be tracked. This overrides the value set in the live config for this session.

Returns

• (::Google::Cloud::Video::Stitcher::V1::AdTracking) — Determines how the ad should be tracked. This overrides the value set in the live config for this session.

#gam_settings

def gam_settings() -> ::Google::Cloud::Video::Stitcher::V1::LiveSession::GamSettings

Returns

• (::Google::Cloud::Video::Stitcher::V1::LiveSession::GamSettings) — This field should be set with appropriate values if GAM is being used for ads.

#gam_settings=

def gam_settings=(value) -> ::Google::Cloud::Video::Stitcher::V1::LiveSession::GamSettings

Parameter

• value (::Google::Cloud::Video::Stitcher::V1::LiveSession::GamSettings) — This field should be set with appropriate values if GAM is being used for ads.

Returns

• (::Google::Cloud::Video::Stitcher::V1::LiveSession::GamSettings) — This field should be set with appropriate values if GAM is being used for ads.

#live_config

def live_config() -> ::String

Returns

• (::String) — Required. The resource name of the live config for this session, in the form of projects/{project}/locations/{location}/liveConfigs/{id}.

#live_config=

def live_config=(value) -> ::String

Parameter

• value (::String) — Required. The resource name of the live config for this session, in the form of projects/{project}/locations/{location}/liveConfigs/{id}.

Returns

• (::String) — Required. The resource name of the live config for this session, in the form of projects/{project}/locations/{location}/liveConfigs/{id}.

#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.