google_youtube_api::MonitorStreamInfo Class Reference

#include <monitor_stream_info.h>

Inheritance diagram for google_youtube_api::MonitorStreamInfo:

Public Member Functions
	MonitorStreamInfo (const Json::Value &storage)
	MonitorStreamInfo (Json::Value *storage)
virtual	~MonitorStreamInfo ()
const StringPiece	GetTypeName () const
bool	has_broadcast_stream_delay_ms () const
void	clear_broadcast_stream_delay_ms ()
uint32	get_broadcast_stream_delay_ms () const
void	set_broadcast_stream_delay_ms (uint32 value)
bool	has_embed_html () const
void	clear_embed_html ()
const StringPiece	get_embed_html () const
void	set_embed_html (const StringPiece &value)
bool	has_enable_monitor_stream () const
void	clear_enable_monitor_stream ()
bool	get_enable_monitor_stream () const
void	set_enable_monitor_stream (bool value)

Static Public Member Functions
static MonitorStreamInfo *	New ()

Detailed Description

Settings and Info of the monitor stream.

Constructor & Destructor Documentation

MonitorStreamInfo() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

MonitorStreamInfo() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~MonitorStreamInfo()

google_youtube_api::MonitorStreamInfo::~MonitorStreamInfo ( )

virtual

Standard destructor.

Member Function Documentation

clear_broadcast_stream_delay_ms()

void google_youtube_api::MonitorStreamInfo::clear_broadcast_stream_delay_ms ( )

inline

Clears the 'broadcastStreamDelayMs' attribute.

clear_embed_html()

void google_youtube_api::MonitorStreamInfo::clear_embed_html ( )

inline

Clears the 'embedHtml' attribute.

clear_enable_monitor_stream()

void google_youtube_api::MonitorStreamInfo::clear_enable_monitor_stream ( )

inline

Clears the 'enableMonitorStream' attribute.

get_broadcast_stream_delay_ms()

uint32 google_youtube_api::MonitorStreamInfo::get_broadcast_stream_delay_ms ( ) const

inline

Get the value of the 'broadcastStreamDelayMs' attribute.

get_embed_html()

const StringPiece google_youtube_api::MonitorStreamInfo::get_embed_html ( ) const

inline

Get the value of the 'embedHtml' attribute.

get_enable_monitor_stream()

bool google_youtube_api::MonitorStreamInfo::get_enable_monitor_stream ( ) const

inline

Get the value of the 'enableMonitorStream' attribute.

GetTypeName()

const StringPiece google_youtube_api::MonitorStreamInfo::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_youtube_api::MonitorStreamInfo

has_broadcast_stream_delay_ms()

bool google_youtube_api::MonitorStreamInfo::has_broadcast_stream_delay_ms ( ) const

inline

Determine if the 'broadcastStreamDelayMs' attribute was set.

Returns

true if the 'broadcastStreamDelayMs' attribute was set.

has_embed_html()

bool google_youtube_api::MonitorStreamInfo::has_embed_html ( ) const

inline

Determine if the 'embedHtml' attribute was set.

Returns

true if the 'embedHtml' attribute was set.

has_enable_monitor_stream()

bool google_youtube_api::MonitorStreamInfo::has_enable_monitor_stream ( ) const

inline

Determine if the 'enableMonitorStream' attribute was set.

Returns

true if the 'enableMonitorStream' attribute was set.

New()

MonitorStreamInfo * google_youtube_api::MonitorStreamInfo::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_broadcast_stream_delay_ms()

void google_youtube_api::MonitorStreamInfo::set_broadcast_stream_delay_ms ( uint32  value )

inline

Change the 'broadcastStreamDelayMs' attribute.

If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.

Parameters

[in]

value

The new value.

set_embed_html()

void google_youtube_api::MonitorStreamInfo::set_embed_html ( const StringPiece &  value )

inline

Change the 'embedHtml' attribute.

HTML code that embeds a player that plays the monitor stream.

Parameters

[in]

value

The new value.

set_enable_monitor_stream()

void google_youtube_api::MonitorStreamInfo::set_enable_monitor_stream ( bool  value )

inline

Change the 'enableMonitorStream' attribute.

This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints.

You need to set this value to true if you intend to have a broadcast delay for your event.

Note: This property cannot be updated once the broadcast is in the testing or live state.

Parameters

[in]

value

The new value.

---

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

• google/youtube_api/monitor_stream_info.h
• google/youtube_api/monitor_stream_info.cc