Video Stitcher V1 API - Class Google::Cloud::Video::Stitcher::V1::VodSession (v1.1.0)

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

Metadata for a VOD session. The session expires 4 hours after its creation.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#ad_tag_macro_map

def ad_tag_macro_map() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Key value pairs for ad tag macro replacement, only available for VOD 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 macro map: {"geoId": "123"}

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

#ad_tag_macro_map=

def ad_tag_macro_map=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Key value pairs for ad tag macro replacement, only available for VOD 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 macro map: {"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 VOD 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 macro map: {"geoId": "123"}

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

#ad_tag_uri

def ad_tag_uri() -> ::String
Returns
  • (::String) — Ad tag URI. For most use cases, you should create a VodConfig with this information rather than setting this field directly.

#ad_tag_uri=

def ad_tag_uri=(value) -> ::String
Parameter
  • value (::String) — Ad tag URI. For most use cases, you should create a VodConfig with this information rather than setting this field directly.
Returns
  • (::String) — Ad tag URI. For most use cases, you should create a VodConfig with this information rather than setting this field directly.

#ad_tracking

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

#ad_tracking=

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

#asset_id

def asset_id() -> ::String
Returns
  • (::String) — Output only. The generated ID of the VodSession's source media.

#gam_settings

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

#gam_settings=

def gam_settings=(value) -> ::Google::Cloud::Video::Stitcher::V1::VodSession::GamSettings
Parameter
Returns

#interstitials

def interstitials() -> ::Google::Cloud::Video::Stitcher::V1::Interstitials
Returns

#manifest_options

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

#manifest_options=

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

#name

def name() -> ::String
Returns
  • (::String) — Output only. The name of the VOD session, in the form of projects/{project_number}/locations/{location}/vodSessions/{id}.

#play_uri

def play_uri() -> ::String
Returns
  • (::String) — Output only. The playback URI of the stitched content.

#source_uri

def source_uri() -> ::String
Returns
  • (::String) — URI of the media to stitch. For most use cases, you should create a VodConfig with this information rather than setting this field directly.

#source_uri=

def source_uri=(value) -> ::String
Parameter
  • value (::String) — URI of the media to stitch. For most use cases, you should create a VodConfig with this information rather than setting this field directly.
Returns
  • (::String) — URI of the media to stitch. For most use cases, you should create a VodConfig with this information rather than setting this field directly.

#vod_config

def vod_config() -> ::String
Returns
  • (::String) — The resource name of the VOD config for this session, in the form of projects/{project}/locations/{location}/vodConfigs/{id}.

#vod_config=

def vod_config=(value) -> ::String
Parameter
  • value (::String) — The resource name of the VOD config for this session, in the form of projects/{project}/locations/{location}/vodConfigs/{id}.
Returns
  • (::String) — The resource name of the VOD config for this session, in the form of projects/{project}/locations/{location}/vodConfigs/{id}.