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

#include <ingestion_info.h>

Inheritance diagram for google_youtube_api::IngestionInfo:

Public Member Functions

 IngestionInfo (const Json::Value &storage)
 
 IngestionInfo (Json::Value *storage)
 
virtual ~IngestionInfo ()
 
const StringPiece GetTypeName () const
 
bool has_backup_ingestion_address () const
 
void clear_backup_ingestion_address ()
 
const StringPiece get_backup_ingestion_address () const
 
void set_backup_ingestion_address (const StringPiece &value)
 
bool has_ingestion_address () const
 
void clear_ingestion_address ()
 
const StringPiece get_ingestion_address () const
 
void set_ingestion_address (const StringPiece &value)
 
bool has_stream_name () const
 
void clear_stream_name ()
 
const StringPiece get_stream_name () const
 
void set_stream_name (const StringPiece &value)
 

Static Public Member Functions

static IngestionInfoNew ()
 

Detailed Description

Describes information necessary for ingesting an RTMP or an HTTP stream.

Constructor & Destructor Documentation

◆ IngestionInfo() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ IngestionInfo() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~IngestionInfo()

google_youtube_api::IngestionInfo::~IngestionInfo ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_backup_ingestion_address()

void google_youtube_api::IngestionInfo::clear_backup_ingestion_address ( )
inline

Clears the 'backupIngestionAddress' attribute.

◆ clear_ingestion_address()

void google_youtube_api::IngestionInfo::clear_ingestion_address ( )
inline

Clears the 'ingestionAddress' attribute.

◆ clear_stream_name()

void google_youtube_api::IngestionInfo::clear_stream_name ( )
inline

Clears the 'streamName' attribute.

◆ get_backup_ingestion_address()

const StringPiece google_youtube_api::IngestionInfo::get_backup_ingestion_address ( ) const
inline

Get the value of the 'backupIngestionAddress' attribute.

◆ get_ingestion_address()

const StringPiece google_youtube_api::IngestionInfo::get_ingestion_address ( ) const
inline

Get the value of the 'ingestionAddress' attribute.

◆ get_stream_name()

const StringPiece google_youtube_api::IngestionInfo::get_stream_name ( ) const
inline

Get the value of the 'streamName' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_youtube_api::IngestionInfo

◆ has_backup_ingestion_address()

bool google_youtube_api::IngestionInfo::has_backup_ingestion_address ( ) const
inline

Determine if the 'backupIngestionAddress' attribute was set.

Returns
true if the 'backupIngestionAddress' attribute was set.

◆ has_ingestion_address()

bool google_youtube_api::IngestionInfo::has_ingestion_address ( ) const
inline

Determine if the 'ingestionAddress' attribute was set.

Returns
true if the 'ingestionAddress' attribute was set.

◆ has_stream_name()

bool google_youtube_api::IngestionInfo::has_stream_name ( ) const
inline

Determine if the 'streamName' attribute was set.

Returns
true if the 'streamName' attribute was set.

◆ New()

IngestionInfo * google_youtube_api::IngestionInfo::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_backup_ingestion_address()

void google_youtube_api::IngestionInfo::set_backup_ingestion_address ( const StringPiece &  value)
inline

Change the 'backupIngestionAddress' attribute.

The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL.

Parameters
[in]valueThe new value.

◆ set_ingestion_address()

void google_youtube_api::IngestionInfo::set_ingestion_address ( const StringPiece &  value)
inline

Change the 'ingestionAddress' attribute.

The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.

Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:

STREAM_URL/STREAM_NAME.

Parameters
[in]valueThe new value.

◆ set_stream_name()

void google_youtube_api::IngestionInfo::set_stream_name ( const StringPiece &  value)
inline

Change the 'streamName' attribute.

The HTTP or RTMP stream name that YouTube assigns to the video stream.

Parameters
[in]valueThe new value.

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