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

#include <video_file_details.h>

Inheritance diagram for google_youtube_api::VideoFileDetails:

Public Member Functions

 VideoFileDetails (const Json::Value &storage)
 
 VideoFileDetails (Json::Value *storage)
 
virtual ~VideoFileDetails ()
 
const StringPiece GetTypeName () const
 
bool has_audio_streams () const
 
void clear_audio_streams ()
 
const client::JsonCppArray< VideoFileDetailsAudioStreamget_audio_streams () const
 
client::JsonCppArray< VideoFileDetailsAudioStreammutable_audioStreams ()
 
bool has_bitrate_bps () const
 
void clear_bitrate_bps ()
 
uint64 get_bitrate_bps () const
 
void set_bitrate_bps (uint64 value)
 
bool has_container () const
 
void clear_container ()
 
const StringPiece get_container () const
 
void set_container (const StringPiece &value)
 
bool has_creation_time () const
 
void clear_creation_time ()
 
const StringPiece get_creation_time () const
 
void set_creation_time (const StringPiece &value)
 
bool has_duration_ms () const
 
void clear_duration_ms ()
 
uint64 get_duration_ms () const
 
void set_duration_ms (uint64 value)
 
bool has_file_name () const
 
void clear_file_name ()
 
const StringPiece get_file_name () const
 
void set_file_name (const StringPiece &value)
 
bool has_file_size () const
 
void clear_file_size ()
 
uint64 get_file_size () const
 
void set_file_size (uint64 value)
 
bool has_file_type () const
 
void clear_file_type ()
 
const StringPiece get_file_type () const
 
void set_file_type (const StringPiece &value)
 
bool has_video_streams () const
 
void clear_video_streams ()
 
const client::JsonCppArray< VideoFileDetailsVideoStreamget_video_streams () const
 
client::JsonCppArray< VideoFileDetailsVideoStreammutable_videoStreams ()
 

Static Public Member Functions

static VideoFileDetailsNew ()
 

Detailed Description

Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information.

Constructor & Destructor Documentation

◆ VideoFileDetails() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ VideoFileDetails() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~VideoFileDetails()

google_youtube_api::VideoFileDetails::~VideoFileDetails ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_audio_streams()

void google_youtube_api::VideoFileDetails::clear_audio_streams ( )
inline

Clears the 'audioStreams' attribute.

◆ clear_bitrate_bps()

void google_youtube_api::VideoFileDetails::clear_bitrate_bps ( )
inline

Clears the 'bitrateBps' attribute.

◆ clear_container()

void google_youtube_api::VideoFileDetails::clear_container ( )
inline

Clears the 'container' attribute.

◆ clear_creation_time()

void google_youtube_api::VideoFileDetails::clear_creation_time ( )
inline

Clears the 'creationTime' attribute.

◆ clear_duration_ms()

void google_youtube_api::VideoFileDetails::clear_duration_ms ( )
inline

Clears the 'durationMs' attribute.

◆ clear_file_name()

void google_youtube_api::VideoFileDetails::clear_file_name ( )
inline

Clears the 'fileName' attribute.

◆ clear_file_size()

void google_youtube_api::VideoFileDetails::clear_file_size ( )
inline

Clears the 'fileSize' attribute.

◆ clear_file_type()

void google_youtube_api::VideoFileDetails::clear_file_type ( )
inline

Clears the 'fileType' attribute.

◆ clear_video_streams()

void google_youtube_api::VideoFileDetails::clear_video_streams ( )
inline

Clears the 'videoStreams' attribute.

◆ get_audio_streams()

const client::JsonCppArray<VideoFileDetailsAudioStream > google_youtube_api::VideoFileDetails::get_audio_streams ( ) const

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

◆ get_bitrate_bps()

uint64 google_youtube_api::VideoFileDetails::get_bitrate_bps ( ) const
inline

Get the value of the 'bitrateBps' attribute.

◆ get_container()

const StringPiece google_youtube_api::VideoFileDetails::get_container ( ) const
inline

Get the value of the 'container' attribute.

◆ get_creation_time()

const StringPiece google_youtube_api::VideoFileDetails::get_creation_time ( ) const
inline

Get the value of the 'creationTime' attribute.

◆ get_duration_ms()

uint64 google_youtube_api::VideoFileDetails::get_duration_ms ( ) const
inline

Get the value of the 'durationMs' attribute.

◆ get_file_name()

const StringPiece google_youtube_api::VideoFileDetails::get_file_name ( ) const
inline

Get the value of the 'fileName' attribute.

◆ get_file_size()

uint64 google_youtube_api::VideoFileDetails::get_file_size ( ) const
inline

Get the value of the 'fileSize' attribute.

◆ get_file_type()

const StringPiece google_youtube_api::VideoFileDetails::get_file_type ( ) const
inline

Get the value of the 'fileType' attribute.

◆ get_video_streams()

const client::JsonCppArray<VideoFileDetailsVideoStream > google_youtube_api::VideoFileDetails::get_video_streams ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_youtube_api::VideoFileDetails

◆ has_audio_streams()

bool google_youtube_api::VideoFileDetails::has_audio_streams ( ) const
inline

Determine if the 'audioStreams' attribute was set.

Returns
true if the 'audioStreams' attribute was set.

◆ has_bitrate_bps()

bool google_youtube_api::VideoFileDetails::has_bitrate_bps ( ) const
inline

Determine if the 'bitrateBps' attribute was set.

Returns
true if the 'bitrateBps' attribute was set.

◆ has_container()

bool google_youtube_api::VideoFileDetails::has_container ( ) const
inline

Determine if the 'container' attribute was set.

Returns
true if the 'container' attribute was set.

◆ has_creation_time()

bool google_youtube_api::VideoFileDetails::has_creation_time ( ) const
inline

Determine if the 'creationTime' attribute was set.

Returns
true if the 'creationTime' attribute was set.

◆ has_duration_ms()

bool google_youtube_api::VideoFileDetails::has_duration_ms ( ) const
inline

Determine if the 'durationMs' attribute was set.

Returns
true if the 'durationMs' attribute was set.

◆ has_file_name()

bool google_youtube_api::VideoFileDetails::has_file_name ( ) const
inline

Determine if the 'fileName' attribute was set.

Returns
true if the 'fileName' attribute was set.

◆ has_file_size()

bool google_youtube_api::VideoFileDetails::has_file_size ( ) const
inline

Determine if the 'fileSize' attribute was set.

Returns
true if the 'fileSize' attribute was set.

◆ has_file_type()

bool google_youtube_api::VideoFileDetails::has_file_type ( ) const
inline

Determine if the 'fileType' attribute was set.

Returns
true if the 'fileType' attribute was set.

◆ has_video_streams()

bool google_youtube_api::VideoFileDetails::has_video_streams ( ) const
inline

Determine if the 'videoStreams' attribute was set.

Returns
true if the 'videoStreams' attribute was set.

◆ mutable_audioStreams()

client::JsonCppArray<VideoFileDetailsAudioStream > google_youtube_api::VideoFileDetails::mutable_audioStreams ( )

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

A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.

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

◆ mutable_videoStreams()

client::JsonCppArray<VideoFileDetailsVideoStream > google_youtube_api::VideoFileDetails::mutable_videoStreams ( )

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

A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.

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

◆ New()

VideoFileDetails * google_youtube_api::VideoFileDetails::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_bitrate_bps()

void google_youtube_api::VideoFileDetails::set_bitrate_bps ( uint64  value)
inline

Change the 'bitrateBps' attribute.

The uploaded video file's combined (video and audio) bitrate in bits per second.

Parameters
[in]valueThe new value.

◆ set_container()

void google_youtube_api::VideoFileDetails::set_container ( const StringPiece &  value)
inline

Change the 'container' attribute.

The uploaded video file's container format.

Parameters
[in]valueThe new value.

◆ set_creation_time()

void google_youtube_api::VideoFileDetails::set_creation_time ( const StringPiece &  value)
inline

Change the 'creationTime' attribute.

The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported:

  • Date only: YYYY-MM-DD
  • Naive time: YYYY-MM-DDTHH:MM:SS
  • Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM.
Parameters
[in]valueThe new value.

◆ set_duration_ms()

void google_youtube_api::VideoFileDetails::set_duration_ms ( uint64  value)
inline

Change the 'durationMs' attribute.

The length of the uploaded video in milliseconds.

Parameters
[in]valueThe new value.

◆ set_file_name()

void google_youtube_api::VideoFileDetails::set_file_name ( const StringPiece &  value)
inline

Change the 'fileName' attribute.

The uploaded file's name. This field is present whether a video file or another type of file was uploaded.

Parameters
[in]valueThe new value.

◆ set_file_size()

void google_youtube_api::VideoFileDetails::set_file_size ( uint64  value)
inline

Change the 'fileSize' attribute.

The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.

Parameters
[in]valueThe new value.

◆ set_file_type()

void google_youtube_api::VideoFileDetails::set_file_type ( const StringPiece &  value)
inline

Change the 'fileType' attribute.

The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.

Parameters
[in]valueThe new value.

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