#include <live_broadcast_content_details.h>

Inheritance diagram for google_youtube_api::LiveBroadcastContentDetails:

Public Member Functions
	LiveBroadcastContentDetails (const Json::Value &storage)

	LiveBroadcastContentDetails (Json::Value *storage)

virtual	~LiveBroadcastContentDetails ()

const StringPiece	GetTypeName () const

bool	has_bound_stream_id () const

void	clear_bound_stream_id ()

const StringPiece	get_bound_stream_id () const

void	set_bound_stream_id (const StringPiece &value)

bool	has_bound_stream_last_update_time_ms () const

void	clear_bound_stream_last_update_time_ms ()

client::DateTime	get_bound_stream_last_update_time_ms () const

void	set_bound_stream_last_update_time_ms (client::DateTime value)

bool	has_closed_captions_type () const

void	clear_closed_captions_type ()

const StringPiece	get_closed_captions_type () const

void	set_closed_captions_type (const StringPiece &value)

bool	has_enable_auto_start () const

void	clear_enable_auto_start ()

bool	get_enable_auto_start () const

void	set_enable_auto_start (bool value)

bool	has_enable_closed_captions () const

void	clear_enable_closed_captions ()

bool	get_enable_closed_captions () const

void	set_enable_closed_captions (bool value)

bool	has_enable_content_encryption () const

void	clear_enable_content_encryption ()

bool	get_enable_content_encryption () const

void	set_enable_content_encryption (bool value)

bool	has_enable_dvr () const

void	clear_enable_dvr ()

bool	get_enable_dvr () const

void	set_enable_dvr (bool value)

bool	has_enable_embed () const

void	clear_enable_embed ()

bool	get_enable_embed () const

void	set_enable_embed (bool value)

bool	has_enable_low_latency () const

void	clear_enable_low_latency ()

bool	get_enable_low_latency () const

void	set_enable_low_latency (bool value)

bool	has_latency_preference () const

void	clear_latency_preference ()

const StringPiece	get_latency_preference () const

void	set_latency_preference (const StringPiece &value)

bool	has_mesh () const

void	clear_mesh ()

const StringPiece	get_mesh () const

void	set_mesh (const StringPiece &value)

bool	has_monitor_stream () const

void	clear_monitor_stream ()

const MonitorStreamInfo	get_monitor_stream () const

MonitorStreamInfo	mutable_monitorStream ()

bool	has_projection () const

void	clear_projection ()

const StringPiece	get_projection () const

void	set_projection (const StringPiece &value)

bool	has_record_from_start () const

void	clear_record_from_start ()

bool	get_record_from_start () const

void	set_record_from_start (bool value)

bool	has_start_with_slate () const

void	clear_start_with_slate ()

bool	get_start_with_slate () const

void	set_start_with_slate (bool value)

bool	has_stereo_layout () const

void	clear_stereo_layout ()

const StringPiece	get_stereo_layout () const

void	set_stereo_layout (const StringPiece &value)

Static Public Member Functions
static LiveBroadcastContentDetails *	New ()

Detailed Description

Detailed settings of a broadcast.

Constructor & Destructor Documentation

◆ LiveBroadcastContentDetails() [1/2]

google_youtube_api::LiveBroadcastContentDetails::LiveBroadcastContentDetails ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ LiveBroadcastContentDetails() [2/2]

google_youtube_api::LiveBroadcastContentDetails::LiveBroadcastContentDetails ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~LiveBroadcastContentDetails()

google_youtube_api::LiveBroadcastContentDetails::~LiveBroadcastContentDetails ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_bound_stream_id()

void google_youtube_api::LiveBroadcastContentDetails::clear_bound_stream_id ( )

inline

Clears the 'boundStreamId' attribute.

◆ clear_bound_stream_last_update_time_ms()

void google_youtube_api::LiveBroadcastContentDetails::clear_bound_stream_last_update_time_ms ( )

inline

Clears the 'boundStreamLastUpdateTimeMs' attribute.

◆ clear_closed_captions_type()

void google_youtube_api::LiveBroadcastContentDetails::clear_closed_captions_type ( )

inline

Clears the 'closedCaptionsType' attribute.

◆ clear_enable_auto_start()

void google_youtube_api::LiveBroadcastContentDetails::clear_enable_auto_start ( )

inline

Clears the 'enableAutoStart' attribute.

◆ clear_enable_closed_captions()

void google_youtube_api::LiveBroadcastContentDetails::clear_enable_closed_captions ( )

inline

Clears the 'enableClosedCaptions' attribute.

◆ clear_enable_content_encryption()

void google_youtube_api::LiveBroadcastContentDetails::clear_enable_content_encryption ( )

inline

Clears the 'enableContentEncryption' attribute.

◆ clear_enable_dvr()

void google_youtube_api::LiveBroadcastContentDetails::clear_enable_dvr ( )

inline

Clears the 'enableDvr' attribute.

◆ clear_enable_embed()

void google_youtube_api::LiveBroadcastContentDetails::clear_enable_embed ( )

inline

Clears the 'enableEmbed' attribute.

◆ clear_enable_low_latency()

void google_youtube_api::LiveBroadcastContentDetails::clear_enable_low_latency ( )

inline

Clears the 'enableLowLatency' attribute.

◆ clear_latency_preference()

void google_youtube_api::LiveBroadcastContentDetails::clear_latency_preference ( )

inline

Clears the 'latencyPreference' attribute.

◆ clear_mesh()

void google_youtube_api::LiveBroadcastContentDetails::clear_mesh ( )

inline

Clears the 'mesh' attribute.

◆ clear_monitor_stream()

void google_youtube_api::LiveBroadcastContentDetails::clear_monitor_stream ( )

inline

Clears the 'monitorStream' attribute.

◆ clear_projection()

void google_youtube_api::LiveBroadcastContentDetails::clear_projection ( )

inline

Clears the 'projection' attribute.

◆ clear_record_from_start()

void google_youtube_api::LiveBroadcastContentDetails::clear_record_from_start ( )

inline

Clears the 'recordFromStart' attribute.

◆ clear_start_with_slate()

void google_youtube_api::LiveBroadcastContentDetails::clear_start_with_slate ( )

inline

Clears the 'startWithSlate' attribute.

◆ clear_stereo_layout()

void google_youtube_api::LiveBroadcastContentDetails::clear_stereo_layout ( )

inline

Clears the 'stereoLayout' attribute.

◆ get_bound_stream_id()

const StringPiece google_youtube_api::LiveBroadcastContentDetails::get_bound_stream_id ( ) const

inline

Get the value of the 'boundStreamId' attribute.

◆ get_bound_stream_last_update_time_ms()

client::DateTime google_youtube_api::LiveBroadcastContentDetails::get_bound_stream_last_update_time_ms ( ) const

inline

Get the value of the 'boundStreamLastUpdateTimeMs' attribute.

◆ get_closed_captions_type()

const StringPiece google_youtube_api::LiveBroadcastContentDetails::get_closed_captions_type ( ) const

inline

Get the value of the 'closedCaptionsType' attribute.

◆ get_enable_auto_start()

bool google_youtube_api::LiveBroadcastContentDetails::get_enable_auto_start ( ) const

inline

Get the value of the 'enableAutoStart' attribute.

◆ get_enable_closed_captions()

bool google_youtube_api::LiveBroadcastContentDetails::get_enable_closed_captions ( ) const

inline

Get the value of the 'enableClosedCaptions' attribute.

◆ get_enable_content_encryption()

bool google_youtube_api::LiveBroadcastContentDetails::get_enable_content_encryption ( ) const

inline

Get the value of the 'enableContentEncryption' attribute.

◆ get_enable_dvr()

bool google_youtube_api::LiveBroadcastContentDetails::get_enable_dvr ( ) const

inline

Get the value of the 'enableDvr' attribute.

◆ get_enable_embed()

bool google_youtube_api::LiveBroadcastContentDetails::get_enable_embed ( ) const

inline

Get the value of the 'enableEmbed' attribute.

◆ get_enable_low_latency()

bool google_youtube_api::LiveBroadcastContentDetails::get_enable_low_latency ( ) const

inline

Get the value of the 'enableLowLatency' attribute.

◆ get_latency_preference()

const StringPiece google_youtube_api::LiveBroadcastContentDetails::get_latency_preference ( ) const

inline

Get the value of the 'latencyPreference' attribute.

◆ get_mesh()

const StringPiece google_youtube_api::LiveBroadcastContentDetails::get_mesh ( ) const

inline

Get the value of the 'mesh' attribute.

◆ get_monitor_stream()

const MonitorStreamInfo google_youtube_api::LiveBroadcastContentDetails::get_monitor_stream ( ) const

Get a reference to the value of the 'monitorStream' attribute.

◆ get_projection()

const StringPiece google_youtube_api::LiveBroadcastContentDetails::get_projection ( ) const

inline

Get the value of the 'projection' attribute.

◆ get_record_from_start()

bool google_youtube_api::LiveBroadcastContentDetails::get_record_from_start ( ) const

inline

Get the value of the 'recordFromStart' attribute.

◆ get_start_with_slate()

bool google_youtube_api::LiveBroadcastContentDetails::get_start_with_slate ( ) const

inline

Get the value of the 'startWithSlate' attribute.

◆ get_stereo_layout()

const StringPiece google_youtube_api::LiveBroadcastContentDetails::get_stereo_layout ( ) const

inline

Get the value of the 'stereoLayout' attribute.

◆ GetTypeName()

const StringPiece google_youtube_api::LiveBroadcastContentDetails::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_youtube_api::LiveBroadcastContentDetails

◆ has_bound_stream_id()

bool google_youtube_api::LiveBroadcastContentDetails::has_bound_stream_id ( ) const

inline

Determine if the 'boundStreamId' attribute was set.

Returns: true if the 'boundStreamId' attribute was set.

◆ has_bound_stream_last_update_time_ms()

bool google_youtube_api::LiveBroadcastContentDetails::has_bound_stream_last_update_time_ms ( ) const

inline

Determine if the 'boundStreamLastUpdateTimeMs' attribute was set.

Returns: true if the 'boundStreamLastUpdateTimeMs' attribute was set.

◆ has_closed_captions_type()

bool google_youtube_api::LiveBroadcastContentDetails::has_closed_captions_type ( ) const

inline

Determine if the 'closedCaptionsType' attribute was set.

Returns: true if the 'closedCaptionsType' attribute was set.

◆ has_enable_auto_start()

bool google_youtube_api::LiveBroadcastContentDetails::has_enable_auto_start ( ) const

inline

Determine if the 'enableAutoStart' attribute was set.

Returns: true if the 'enableAutoStart' attribute was set.

◆ has_enable_closed_captions()

bool google_youtube_api::LiveBroadcastContentDetails::has_enable_closed_captions ( ) const

inline

Determine if the 'enableClosedCaptions' attribute was set.

Returns: true if the 'enableClosedCaptions' attribute was set.

◆ has_enable_content_encryption()

bool google_youtube_api::LiveBroadcastContentDetails::has_enable_content_encryption ( ) const

inline

Determine if the 'enableContentEncryption' attribute was set.

Returns: true if the 'enableContentEncryption' attribute was set.

◆ has_enable_dvr()

bool google_youtube_api::LiveBroadcastContentDetails::has_enable_dvr ( ) const

inline

Determine if the 'enableDvr' attribute was set.

Returns: true if the 'enableDvr' attribute was set.

◆ has_enable_embed()

bool google_youtube_api::LiveBroadcastContentDetails::has_enable_embed ( ) const

inline

Determine if the 'enableEmbed' attribute was set.

Returns: true if the 'enableEmbed' attribute was set.

◆ has_enable_low_latency()

bool google_youtube_api::LiveBroadcastContentDetails::has_enable_low_latency ( ) const

inline

Determine if the 'enableLowLatency' attribute was set.

Returns: true if the 'enableLowLatency' attribute was set.

◆ has_latency_preference()

bool google_youtube_api::LiveBroadcastContentDetails::has_latency_preference ( ) const

inline

Determine if the 'latencyPreference' attribute was set.

Returns: true if the 'latencyPreference' attribute was set.

◆ has_mesh()

bool google_youtube_api::LiveBroadcastContentDetails::has_mesh ( ) const

inline

Determine if the 'mesh' attribute was set.

Returns: true if the 'mesh' attribute was set.

◆ has_monitor_stream()

bool google_youtube_api::LiveBroadcastContentDetails::has_monitor_stream ( ) const

inline

Determine if the 'monitorStream' attribute was set.

Returns: true if the 'monitorStream' attribute was set.

◆ has_projection()

bool google_youtube_api::LiveBroadcastContentDetails::has_projection ( ) const

inline

Determine if the 'projection' attribute was set.

Returns: true if the 'projection' attribute was set.

◆ has_record_from_start()

bool google_youtube_api::LiveBroadcastContentDetails::has_record_from_start ( ) const

inline

Determine if the 'recordFromStart' attribute was set.

Returns: true if the 'recordFromStart' attribute was set.

◆ has_start_with_slate()

bool google_youtube_api::LiveBroadcastContentDetails::has_start_with_slate ( ) const

inline

Determine if the 'startWithSlate' attribute was set.

Returns: true if the 'startWithSlate' attribute was set.

◆ has_stereo_layout()

bool google_youtube_api::LiveBroadcastContentDetails::has_stereo_layout ( ) const

inline

Determine if the 'stereoLayout' attribute was set.

Returns: true if the 'stereoLayout' attribute was set.

◆ mutable_monitorStream()

MonitorStreamInfo google_youtube_api::LiveBroadcastContentDetails::mutable_monitorStream ( )

Gets a reference to a mutable value of the 'monitorStream' property.

The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.

Returns: The result can be modified to change the attribute value.

◆ New()

LiveBroadcastContentDetails * google_youtube_api::LiveBroadcastContentDetails::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_bound_stream_id()

void google_youtube_api::LiveBroadcastContentDetails::set_bound_stream_id ( const StringPiece & value )

inline

Change the 'boundStreamId' attribute.

This value uniquely identifies the live stream bound to the broadcast.

Parameters

[in] value The new value.

◆ set_bound_stream_last_update_time_ms()

void google_youtube_api::LiveBroadcastContentDetails::set_bound_stream_last_update_time_ms ( client::DateTime value )

inline

Change the 'boundStreamLastUpdateTimeMs' attribute.

The date and time that the live stream referenced by boundStreamId was last updated.

Parameters

[in] value The new value.

◆ set_closed_captions_type()

void google_youtube_api::LiveBroadcastContentDetails::set_closed_captions_type ( const StringPiece & value )

inline

Change the 'closedCaptionsType' attribute.

Parameters

[in] value The new value.

◆ set_enable_auto_start()

void google_youtube_api::LiveBroadcastContentDetails::set_enable_auto_start ( bool value )

inline

Change the 'enableAutoStart' attribute.

This setting indicates whether auto start is enabled for this broadcast.

Parameters

[in] value The new value.

◆ set_enable_closed_captions()

void google_youtube_api::LiveBroadcastContentDetails::set_enable_closed_captions ( bool value )

inline

Change the 'enableClosedCaptions' attribute.

This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.

Parameters

[in] value The new value.

◆ set_enable_content_encryption()

void google_youtube_api::LiveBroadcastContentDetails::set_enable_content_encryption ( bool value )

inline

Change the 'enableContentEncryption' attribute.

This setting indicates whether YouTube should enable content encryption for the broadcast.

Parameters

[in] value The new value.

◆ set_enable_dvr()

void google_youtube_api::LiveBroadcastContentDetails::set_enable_dvr ( bool value )

inline

Change the 'enableDvr' attribute.

This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true.

Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.

Parameters

[in] value The new value.

◆ set_enable_embed()

void google_youtube_api::LiveBroadcastContentDetails::set_enable_embed ( bool value )

inline

Change the 'enableEmbed' attribute.

This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.

Parameters

[in] value The new value.

◆ set_enable_low_latency()

void google_youtube_api::LiveBroadcastContentDetails::set_enable_low_latency ( bool value )

inline

Change the 'enableLowLatency' attribute.

Indicates whether this broadcast has low latency enabled.

Parameters

[in] value The new value.

◆ set_latency_preference()

void google_youtube_api::LiveBroadcastContentDetails::set_latency_preference ( const StringPiece & value )

inline

Change the 'latencyPreference' attribute.

If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.

Parameters

[in] value The new value.

◆ set_mesh()

void google_youtube_api::LiveBroadcastContentDetails::set_mesh ( const StringPiece & value )

inline

Change the 'mesh' attribute.

The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.

Parameters

[in] value The new value.

◆ set_projection()

void google_youtube_api::LiveBroadcastContentDetails::set_projection ( const StringPiece & value )

inline

Change the 'projection' attribute.

The projection format of this broadcast. This defaults to rectangular.

Parameters

[in] value The new value.

◆ set_record_from_start()

void google_youtube_api::LiveBroadcastContentDetails::set_record_from_start ( bool value )

inline

Change the 'recordFromStart' attribute.

Automatically start recording after the event goes live. The default value for this property is true.

Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.

Parameters

[in] value The new value.

◆ set_start_with_slate()

void google_youtube_api::LiveBroadcastContentDetails::set_start_with_slate ( bool value )

inline

Change the 'startWithSlate' attribute.

This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.

Parameters

[in] value The new value.

◆ set_stereo_layout()

void google_youtube_api::LiveBroadcastContentDetails::set_stereo_layout ( const StringPiece & value )

inline

Change the 'stereoLayout' attribute.

Parameters

[in] value The new value.

The documentation for this class was generated from the following files:

google/youtube_api/live_broadcast_content_details.h
google/youtube_api/live_broadcast_content_details.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ LiveBroadcastContentDetails() [1/2]

◆ LiveBroadcastContentDetails() [2/2]

◆ ~LiveBroadcastContentDetails()

Member Function Documentation

◆ clear_bound_stream_id()

◆ clear_bound_stream_last_update_time_ms()

◆ clear_closed_captions_type()

◆ clear_enable_auto_start()

◆ clear_enable_closed_captions()

◆ clear_enable_content_encryption()

◆ clear_enable_dvr()

◆ clear_enable_embed()

◆ clear_enable_low_latency()

◆ clear_latency_preference()

◆ clear_mesh()

◆ clear_monitor_stream()

◆ clear_projection()

◆ clear_record_from_start()

◆ clear_start_with_slate()

◆ clear_stereo_layout()

◆ get_bound_stream_id()

◆ get_bound_stream_last_update_time_ms()

◆ get_closed_captions_type()

◆ get_enable_auto_start()

◆ get_enable_closed_captions()

◆ get_enable_content_encryption()

◆ get_enable_dvr()

◆ get_enable_embed()

◆ get_enable_low_latency()

◆ get_latency_preference()

◆ get_mesh()

◆ get_monitor_stream()

◆ get_projection()

◆ get_record_from_start()

◆ get_start_with_slate()

◆ get_stereo_layout()

◆ GetTypeName()

◆ has_bound_stream_id()

◆ has_bound_stream_last_update_time_ms()

◆ has_closed_captions_type()

◆ has_enable_auto_start()

◆ has_enable_closed_captions()

◆ has_enable_content_encryption()

◆ has_enable_dvr()

◆ has_enable_embed()

◆ has_enable_low_latency()

◆ has_latency_preference()

◆ has_mesh()

◆ has_monitor_stream()

◆ has_projection()

◆ has_record_from_start()

◆ has_start_with_slate()

◆ has_stereo_layout()

◆ mutable_monitorStream()

◆ New()

◆ set_bound_stream_id()

◆ set_bound_stream_last_update_time_ms()

◆ set_closed_captions_type()

◆ set_enable_auto_start()

◆ set_enable_closed_captions()

◆ set_enable_content_encryption()

◆ set_enable_dvr()

◆ set_enable_embed()

◆ set_enable_low_latency()

◆ set_latency_preference()

◆ set_mesh()

◆ set_projection()

◆ set_record_from_start()

◆ set_start_with_slate()

◆ set_stereo_layout()