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

#include <video_live_streaming_details.h>

Inheritance diagram for google_youtube_api::VideoLiveStreamingDetails:

Public Member Functions

 VideoLiveStreamingDetails (const Json::Value &storage)
 
 VideoLiveStreamingDetails (Json::Value *storage)
 
virtual ~VideoLiveStreamingDetails ()
 
const StringPiece GetTypeName () const
 
bool has_active_live_chat_id () const
 
void clear_active_live_chat_id ()
 
const StringPiece get_active_live_chat_id () const
 
void set_active_live_chat_id (const StringPiece &value)
 
bool has_actual_end_time () const
 
void clear_actual_end_time ()
 
client::DateTime get_actual_end_time () const
 
void set_actual_end_time (client::DateTime value)
 
bool has_actual_start_time () const
 
void clear_actual_start_time ()
 
client::DateTime get_actual_start_time () const
 
void set_actual_start_time (client::DateTime value)
 
bool has_concurrent_viewers () const
 
void clear_concurrent_viewers ()
 
uint64 get_concurrent_viewers () const
 
void set_concurrent_viewers (uint64 value)
 
bool has_scheduled_end_time () const
 
void clear_scheduled_end_time ()
 
client::DateTime get_scheduled_end_time () const
 
void set_scheduled_end_time (client::DateTime value)
 
bool has_scheduled_start_time () const
 
void clear_scheduled_start_time ()
 
client::DateTime get_scheduled_start_time () const
 
void set_scheduled_start_time (client::DateTime value)
 

Static Public Member Functions

static VideoLiveStreamingDetailsNew ()
 

Detailed Description

Details about the live streaming metadata.

Constructor & Destructor Documentation

◆ VideoLiveStreamingDetails() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ VideoLiveStreamingDetails() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~VideoLiveStreamingDetails()

google_youtube_api::VideoLiveStreamingDetails::~VideoLiveStreamingDetails ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_active_live_chat_id()

void google_youtube_api::VideoLiveStreamingDetails::clear_active_live_chat_id ( )
inline

Clears the 'activeLiveChatId' attribute.

◆ clear_actual_end_time()

void google_youtube_api::VideoLiveStreamingDetails::clear_actual_end_time ( )
inline

Clears the 'actualEndTime' attribute.

◆ clear_actual_start_time()

void google_youtube_api::VideoLiveStreamingDetails::clear_actual_start_time ( )
inline

Clears the 'actualStartTime' attribute.

◆ clear_concurrent_viewers()

void google_youtube_api::VideoLiveStreamingDetails::clear_concurrent_viewers ( )
inline

Clears the 'concurrentViewers' attribute.

◆ clear_scheduled_end_time()

void google_youtube_api::VideoLiveStreamingDetails::clear_scheduled_end_time ( )
inline

Clears the 'scheduledEndTime' attribute.

◆ clear_scheduled_start_time()

void google_youtube_api::VideoLiveStreamingDetails::clear_scheduled_start_time ( )
inline

Clears the 'scheduledStartTime' attribute.

◆ get_active_live_chat_id()

const StringPiece google_youtube_api::VideoLiveStreamingDetails::get_active_live_chat_id ( ) const
inline

Get the value of the 'activeLiveChatId' attribute.

◆ get_actual_end_time()

client::DateTime google_youtube_api::VideoLiveStreamingDetails::get_actual_end_time ( ) const
inline

Get the value of the 'actualEndTime' attribute.

◆ get_actual_start_time()

client::DateTime google_youtube_api::VideoLiveStreamingDetails::get_actual_start_time ( ) const
inline

Get the value of the 'actualStartTime' attribute.

◆ get_concurrent_viewers()

uint64 google_youtube_api::VideoLiveStreamingDetails::get_concurrent_viewers ( ) const
inline

Get the value of the 'concurrentViewers' attribute.

◆ get_scheduled_end_time()

client::DateTime google_youtube_api::VideoLiveStreamingDetails::get_scheduled_end_time ( ) const
inline

Get the value of the 'scheduledEndTime' attribute.

◆ get_scheduled_start_time()

client::DateTime google_youtube_api::VideoLiveStreamingDetails::get_scheduled_start_time ( ) const
inline

Get the value of the 'scheduledStartTime' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_youtube_api::VideoLiveStreamingDetails

◆ has_active_live_chat_id()

bool google_youtube_api::VideoLiveStreamingDetails::has_active_live_chat_id ( ) const
inline

Determine if the 'activeLiveChatId' attribute was set.

Returns
true if the 'activeLiveChatId' attribute was set.

◆ has_actual_end_time()

bool google_youtube_api::VideoLiveStreamingDetails::has_actual_end_time ( ) const
inline

Determine if the 'actualEndTime' attribute was set.

Returns
true if the 'actualEndTime' attribute was set.

◆ has_actual_start_time()

bool google_youtube_api::VideoLiveStreamingDetails::has_actual_start_time ( ) const
inline

Determine if the 'actualStartTime' attribute was set.

Returns
true if the 'actualStartTime' attribute was set.

◆ has_concurrent_viewers()

bool google_youtube_api::VideoLiveStreamingDetails::has_concurrent_viewers ( ) const
inline

Determine if the 'concurrentViewers' attribute was set.

Returns
true if the 'concurrentViewers' attribute was set.

◆ has_scheduled_end_time()

bool google_youtube_api::VideoLiveStreamingDetails::has_scheduled_end_time ( ) const
inline

Determine if the 'scheduledEndTime' attribute was set.

Returns
true if the 'scheduledEndTime' attribute was set.

◆ has_scheduled_start_time()

bool google_youtube_api::VideoLiveStreamingDetails::has_scheduled_start_time ( ) const
inline

Determine if the 'scheduledStartTime' attribute was set.

Returns
true if the 'scheduledStartTime' attribute was set.

◆ New()

VideoLiveStreamingDetails * google_youtube_api::VideoLiveStreamingDetails::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_active_live_chat_id()

void google_youtube_api::VideoLiveStreamingDetails::set_active_live_chat_id ( const StringPiece &  value)
inline

Change the 'activeLiveChatId' attribute.

The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page.

Parameters
[in]valueThe new value.

◆ set_actual_end_time()

void google_youtube_api::VideoLiveStreamingDetails::set_actual_end_time ( client::DateTime  value)
inline

Change the 'actualEndTime' attribute.

The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over.

Parameters
[in]valueThe new value.

◆ set_actual_start_time()

void google_youtube_api::VideoLiveStreamingDetails::set_actual_start_time ( client::DateTime  value)
inline

Change the 'actualStartTime' attribute.

The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins.

Parameters
[in]valueThe new value.

◆ set_concurrent_viewers()

void google_youtube_api::VideoLiveStreamingDetails::set_concurrent_viewers ( uint64  value)
inline

Change the 'concurrentViewers' attribute.

The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.

Parameters
[in]valueThe new value.

◆ set_scheduled_end_time()

void google_youtube_api::VideoLiveStreamingDetails::set_scheduled_end_time ( client::DateTime  value)
inline

Change the 'scheduledEndTime' attribute.

The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely.

Parameters
[in]valueThe new value.

◆ set_scheduled_start_time()

void google_youtube_api::VideoLiveStreamingDetails::set_scheduled_start_time ( client::DateTime  value)
inline

Change the 'scheduledStartTime' attribute.

The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

Parameters
[in]valueThe new value.

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