youtube  v3
Public Member Functions | Static Public Member Functions | List of all members
google_youtube_api::LiveBroadcast Class Reference

#include <live_broadcast.h>

Inheritance diagram for google_youtube_api::LiveBroadcast:

Public Member Functions

 LiveBroadcast (const Json::Value &storage)
 
 LiveBroadcast (Json::Value *storage)
 
virtual ~LiveBroadcast ()
 
const StringPiece GetTypeName () const
 
bool has_content_details () const
 
void clear_content_details ()
 
const LiveBroadcastContentDetails get_content_details () const
 
LiveBroadcastContentDetails mutable_contentDetails ()
 
bool has_etag () const
 
void clear_etag ()
 
const StringPiece get_etag () const
 
void set_etag (const StringPiece &value)
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_snippet () const
 
void clear_snippet ()
 
const LiveBroadcastSnippet get_snippet () const
 
LiveBroadcastSnippet mutable_snippet ()
 
bool has_statistics () const
 
void clear_statistics ()
 
const LiveBroadcastStatistics get_statistics () const
 
LiveBroadcastStatistics mutable_statistics ()
 
bool has_status () const
 
void clear_status ()
 
const LiveBroadcastStatus get_status () const
 
LiveBroadcastStatus mutable_status ()
 

Static Public Member Functions

static LiveBroadcastNew ()
 

Detailed Description

A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.

Constructor & Destructor Documentation

◆ LiveBroadcast() [1/2]

google_youtube_api::LiveBroadcast::LiveBroadcast ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ LiveBroadcast() [2/2]

google_youtube_api::LiveBroadcast::LiveBroadcast ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~LiveBroadcast()

google_youtube_api::LiveBroadcast::~LiveBroadcast ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_content_details()

void google_youtube_api::LiveBroadcast::clear_content_details ( )
inline

Clears the 'contentDetails' attribute.

◆ clear_etag()

void google_youtube_api::LiveBroadcast::clear_etag ( )
inline

Clears the 'etag' attribute.

◆ clear_id()

void google_youtube_api::LiveBroadcast::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_youtube_api::LiveBroadcast::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_snippet()

void google_youtube_api::LiveBroadcast::clear_snippet ( )
inline

Clears the 'snippet' attribute.

◆ clear_statistics()

void google_youtube_api::LiveBroadcast::clear_statistics ( )
inline

Clears the 'statistics' attribute.

◆ clear_status()

void google_youtube_api::LiveBroadcast::clear_status ( )
inline

Clears the 'status' attribute.

◆ get_content_details()

const LiveBroadcastContentDetails google_youtube_api::LiveBroadcast::get_content_details ( ) const

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

◆ get_etag()

const StringPiece google_youtube_api::LiveBroadcast::get_etag ( ) const
inline

Get the value of the 'etag' attribute.

◆ get_id()

const StringPiece google_youtube_api::LiveBroadcast::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_youtube_api::LiveBroadcast::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_snippet()

const LiveBroadcastSnippet google_youtube_api::LiveBroadcast::get_snippet ( ) const

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

◆ get_statistics()

const LiveBroadcastStatistics google_youtube_api::LiveBroadcast::get_statistics ( ) const

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

◆ get_status()

const LiveBroadcastStatus google_youtube_api::LiveBroadcast::get_status ( ) const

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

◆ GetTypeName()

const StringPiece google_youtube_api::LiveBroadcast::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_youtube_api::LiveBroadcast

◆ has_content_details()

bool google_youtube_api::LiveBroadcast::has_content_details ( ) const
inline

Determine if the 'contentDetails' attribute was set.

Returns
true if the 'contentDetails' attribute was set.

◆ has_etag()

bool google_youtube_api::LiveBroadcast::has_etag ( ) const
inline

Determine if the 'etag' attribute was set.

Returns
true if the 'etag' attribute was set.

◆ has_id()

bool google_youtube_api::LiveBroadcast::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_kind()

bool google_youtube_api::LiveBroadcast::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_snippet()

bool google_youtube_api::LiveBroadcast::has_snippet ( ) const
inline

Determine if the 'snippet' attribute was set.

Returns
true if the 'snippet' attribute was set.

◆ has_statistics()

bool google_youtube_api::LiveBroadcast::has_statistics ( ) const
inline

Determine if the 'statistics' attribute was set.

Returns
true if the 'statistics' attribute was set.

◆ has_status()

bool google_youtube_api::LiveBroadcast::has_status ( ) const
inline

Determine if the 'status' attribute was set.

Returns
true if the 'status' attribute was set.

◆ mutable_contentDetails()

LiveBroadcastContentDetails google_youtube_api::LiveBroadcast::mutable_contentDetails ( )

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

The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.

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

◆ mutable_snippet()

LiveBroadcastSnippet google_youtube_api::LiveBroadcast::mutable_snippet ( )

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

The snippet object contains basic details about the event, including its title, description, start time, and end time.

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

◆ mutable_statistics()

LiveBroadcastStatistics google_youtube_api::LiveBroadcast::mutable_statistics ( )

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

The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.

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

◆ mutable_status()

LiveBroadcastStatus google_youtube_api::LiveBroadcast::mutable_status ( )

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

The status object contains information about the event's status.

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

◆ New()

LiveBroadcast * google_youtube_api::LiveBroadcast::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_etag()

void google_youtube_api::LiveBroadcast::set_etag ( const StringPiece &  value)
inline

Change the 'etag' attribute.

Etag of this resource.

Parameters
[in]valueThe new value.

◆ set_id()

void google_youtube_api::LiveBroadcast::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

The ID that YouTube assigns to uniquely identify the broadcast.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_youtube_api::LiveBroadcast::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".

Parameters
[in]valueThe new value.

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