google_youtube_api::LiveBroadcastStatistics Class Reference

#include <live_broadcast_statistics.h>

Inheritance diagram for google_youtube_api::LiveBroadcastStatistics:

Public Member Functions
	LiveBroadcastStatistics (const Json::Value &storage)
	LiveBroadcastStatistics (Json::Value *storage)
virtual	~LiveBroadcastStatistics ()
const StringPiece	GetTypeName () const
bool	has_concurrent_viewers () const
void	clear_concurrent_viewers ()
uint64	get_concurrent_viewers () const
void	set_concurrent_viewers (uint64 value)
bool	has_total_chat_count () const
void	clear_total_chat_count ()
uint64	get_total_chat_count () const
void	set_total_chat_count (uint64 value)

Static Public Member Functions
static LiveBroadcastStatistics *	New ()

Detailed Description

Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts.

Constructor & Destructor Documentation

LiveBroadcastStatistics() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

LiveBroadcastStatistics() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~LiveBroadcastStatistics()

google_youtube_api::LiveBroadcastStatistics::~LiveBroadcastStatistics ( )

virtual

Standard destructor.

Member Function Documentation

clear_concurrent_viewers()

void google_youtube_api::LiveBroadcastStatistics::clear_concurrent_viewers ( )

inline

Clears the 'concurrentViewers' attribute.

clear_total_chat_count()

void google_youtube_api::LiveBroadcastStatistics::clear_total_chat_count ( )

inline

Clears the 'totalChatCount' attribute.

get_concurrent_viewers()

uint64 google_youtube_api::LiveBroadcastStatistics::get_concurrent_viewers ( ) const

inline

Get the value of the 'concurrentViewers' attribute.

get_total_chat_count()

uint64 google_youtube_api::LiveBroadcastStatistics::get_total_chat_count ( ) const

inline

Get the value of the 'totalChatCount' attribute.

GetTypeName()

const StringPiece google_youtube_api::LiveBroadcastStatistics::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_youtube_api::LiveBroadcastStatistics

has_concurrent_viewers()

bool google_youtube_api::LiveBroadcastStatistics::has_concurrent_viewers ( ) const

inline

Determine if the 'concurrentViewers' attribute was set.

Returns

true if the 'concurrentViewers' attribute was set.

has_total_chat_count()

bool google_youtube_api::LiveBroadcastStatistics::has_total_chat_count ( ) const

inline

Determine if the 'totalChatCount' attribute was set.

Returns

true if the 'totalChatCount' attribute was set.

New()

LiveBroadcastStatistics * google_youtube_api::LiveBroadcastStatistics::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_concurrent_viewers()

void google_youtube_api::LiveBroadcastStatistics::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]

value

The new value.

set_total_chat_count()

void google_youtube_api::LiveBroadcastStatistics::set_total_chat_count ( uint64  value )

inline

Change the 'totalChatCount' attribute.

The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.

Parameters

[in]

value

The new value.

---

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

• google/youtube_api/live_broadcast_statistics.h
• google/youtube_api/live_broadcast_statistics.cc