Reference documentation and code samples for the Google Cloud Video Stitcher V1 Client class LiveSession.
Metadata for a live session.
Generated from protobuf message google.cloud.video.stitcher.v1.LiveSession
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The name of the live session, in the form of projects/{project}/locations/{location}/liveSessions/{id}
.
↳ play_uri
string
Output only. The URI to play the live session's ad-stitched stream.
↳ source_uri
string
The URI of the live session's source stream.
↳ default_ad_tag_id
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
.
↳ ad_tag_map
array| Google\Protobuf\Internal\MapField
Key value pairs for ad tags. Ads parsed from ad tags must be MP4 videos each with at least one audio track.
↳ ad_tag_macros
array| Google\Protobuf\Internal\MapField
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"
↳ client_ad_tracking
bool
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_slate_id
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.
↳ stitching_policy
int
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
.
↳ manifest_options
Google\Cloud\Video\Stitcher\V1\ManifestOptions
Additional options that affect the output of the manifest.
↳ stream_id
string
Output only. The generated ID of the LiveSession's source stream.
getName
Output only. The name of the live session, in the form of projects/{project}/locations/{location}/liveSessions/{id}
.
string
setName
Output only. The name of the live session, in the form of projects/{project}/locations/{location}/liveSessions/{id}
.
var
string
$this
getPlayUri
Output only. The URI to play the live session's ad-stitched stream.
string
setPlayUri
Output only. The URI to play the live session's ad-stitched stream.
var
string
$this
getSourceUri
The URI of the live session's source stream.
string
setSourceUri
The URI of the live session's source stream.
var
string
$this
getDefaultAdTagId
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
.
string
setDefaultAdTagId
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
.
var
string
$this
getAdTagMap
Key value pairs for ad tags. Ads parsed from ad tags must be MP4 videos each with at least one audio track.
setAdTagMap
Key value pairs for ad tags. Ads parsed from ad tags must be MP4 videos each with at least one audio track.
$this
getAdTagMacros
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"
setAdTagMacros
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"
$this
getClientAdTracking
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.
bool
setClientAdTracking
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.
var
bool
$this
getDefaultSlateId
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.
string
setDefaultSlateId
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.
var
string
$this
getStitchingPolicy
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
.
int
setStitchingPolicy
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
.
var
int
$this
getManifestOptions
Additional options that affect the output of the manifest.
hasManifestOptions
clearManifestOptions
setManifestOptions
Additional options that affect the output of the manifest.
$this
getStreamId
Output only. The generated ID of the LiveSession's source stream.
string
setStreamId
Output only. The generated ID of the LiveSession's source stream.
var
string
$this
