Video Stitcher v1 API - Class LiveSession (1.1.0)

public sealed class LiveSession : IMessage<LiveSession>, IEquatable<LiveSession>, IDeepCloneable<LiveSession>, IBufferMessage, IMessage

Reference documentation and code samples for the Video Stitcher v1 API class LiveSession.

Metadata for a live session.

Inheritance

Object > LiveSession

Namespace

Google.Cloud.Video.Stitcher.V1

Assembly

Google.Cloud.Video.Stitcher.V1.dll

Constructors

LiveSession()

public LiveSession()

LiveSession(LiveSession)

public LiveSession(LiveSession other)
Parameter
NameDescription
otherLiveSession

Properties

AdTagMacros

public MapField<string, string> AdTagMacros { get; }

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: {&quot;geoId&quot;: &quot;123&quot;}

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

Property Value
TypeDescription
MapField<String, String>

AdTagMap

public MapField<string, AdTag> AdTagMap { get; }

Key value pairs for ad tags. Ads parsed from ad tags must be MP4 videos each with at least one audio track.

Property Value
TypeDescription
MapField<String, AdTag>

ClientAdTracking

public bool ClientAdTracking { get; set; }

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.

Property Value
TypeDescription
Boolean

DefaultAdTagId

public string DefaultAdTagId { get; set; }

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.

Property Value
TypeDescription
String

DefaultSlateId

public string DefaultSlateId { get; set; }

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.

Property Value
TypeDescription
String

LiveSessionName

public LiveSessionName LiveSessionName { get; set; }

LiveSessionName-typed view over the Name resource name property.

Property Value
TypeDescription
LiveSessionName

ManifestOptions

public ManifestOptions ManifestOptions { get; set; }

Additional options that affect the output of the manifest.

Property Value
TypeDescription
ManifestOptions

Name

public string Name { get; set; }

Output only. The name of the live session, in the form of projects/{project}/locations/{location}/liveSessions/{id}.

Property Value
TypeDescription
String

PlayUri

public string PlayUri { get; set; }

Output only. The URI to play the live session's ad-stitched stream.

Property Value
TypeDescription
String

SourceUri

public string SourceUri { get; set; }

The URI of the live session's source stream.

Property Value
TypeDescription
String

StitchingPolicy

public LiveSession.Types.StitchingPolicy StitchingPolicy { get; set; }

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.

Property Value
TypeDescription
LiveSession.Types.StitchingPolicy

StreamId

public string StreamId { get; set; }

Output only. The generated ID of the LiveSession's source stream.

Property Value
TypeDescription
String