youtube  v3
Public Member Functions | Static Public Member Functions | List of all members
google_youtube_api::LiveStreamContentDetails Class Reference
YouTube Data API Data Objects

#include <live_stream_content_details.h>

Inheritance diagram for google_youtube_api::LiveStreamContentDetails:

Public Member Functions

 LiveStreamContentDetails (const Json::Value &storage)
 
 LiveStreamContentDetails (Json::Value *storage)
 
virtual ~LiveStreamContentDetails ()
 
const StringPiece GetTypeName () const
 
bool has_closed_captions_ingestion_url () const
 
void clear_closed_captions_ingestion_url ()
 
const StringPiece get_closed_captions_ingestion_url () const
 
void set_closed_captions_ingestion_url (const StringPiece &value)
 
bool has_is_reusable () const
 
void clear_is_reusable ()
 
bool get_is_reusable () const
 
void set_is_reusable (bool value)
 

Static Public Member Functions

static LiveStreamContentDetails * New ()
 

Detailed Description

Detailed settings of a stream.

Constructor & Destructor Documentation

◆ LiveStreamContentDetails() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ LiveStreamContentDetails() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~LiveStreamContentDetails()

google_youtube_api::LiveStreamContentDetails::~LiveStreamContentDetails ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_closed_captions_ingestion_url()

void google_youtube_api::LiveStreamContentDetails::clear_closed_captions_ingestion_url ( )
inline

Clears the 'closedCaptionsIngestionUrl' attribute.

◆ clear_is_reusable()

void google_youtube_api::LiveStreamContentDetails::clear_is_reusable ( )
inline

Clears the 'isReusable' attribute.

◆ get_closed_captions_ingestion_url()

const StringPiece google_youtube_api::LiveStreamContentDetails::get_closed_captions_ingestion_url ( ) const
inline

Get the value of the 'closedCaptionsIngestionUrl' attribute.

◆ get_is_reusable()

bool google_youtube_api::LiveStreamContentDetails::get_is_reusable ( ) const
inline

Get the value of the 'isReusable' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_youtube_api::LiveStreamContentDetails

◆ has_closed_captions_ingestion_url()

bool google_youtube_api::LiveStreamContentDetails::has_closed_captions_ingestion_url ( ) const
inline

Determine if the 'closedCaptionsIngestionUrl' attribute was set.

Returns
true if the 'closedCaptionsIngestionUrl' attribute was set.

◆ has_is_reusable()

bool google_youtube_api::LiveStreamContentDetails::has_is_reusable ( ) const
inline

Determine if the 'isReusable' attribute was set.

Returns
true if the 'isReusable' attribute was set.

◆ New()

LiveStreamContentDetails * google_youtube_api::LiveStreamContentDetails::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_closed_captions_ingestion_url()

void google_youtube_api::LiveStreamContentDetails::set_closed_captions_ingestion_url ( const StringPiece &  value)
inline

Change the 'closedCaptionsIngestionUrl' attribute.

The ingestion URL where the closed captions of this stream are sent.

Parameters
[in]valueThe new value.

◆ set_is_reusable()

void google_youtube_api::LiveStreamContentDetails::set_is_reusable ( bool  value)
inline

Change the 'isReusable' attribute.

Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times.

If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways:

  • A non-reusable stream can only be bound to one broadcast.
  • A non-reusable stream might be deleted by an automated process after the broadcast ends.
  • The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.
Parameters
[in]valueThe new value.
The documentation for this class was generated from the following files: