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

#include <video.h>

Inheritance diagram for google_youtube_api::Video:

Public Member Functions

 Video (const Json::Value &storage)
 
 Video (Json::Value *storage)
 
virtual ~Video ()
 
const StringPiece GetTypeName () const
 
bool has_age_gating () const
 
void clear_age_gating ()
 
const VideoAgeGating get_age_gating () const
 
VideoAgeGating mutable_ageGating ()
 
bool has_content_details () const
 
void clear_content_details ()
 
const VideoContentDetails get_content_details () const
 
VideoContentDetails mutable_contentDetails ()
 
bool has_etag () const
 
void clear_etag ()
 
const StringPiece get_etag () const
 
void set_etag (const StringPiece &value)
 
bool has_file_details () const
 
void clear_file_details ()
 
const VideoFileDetails get_file_details () const
 
VideoFileDetails mutable_fileDetails ()
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_live_streaming_details () const
 
void clear_live_streaming_details ()
 
const VideoLiveStreamingDetails get_live_streaming_details () const
 
VideoLiveStreamingDetails mutable_liveStreamingDetails ()
 
bool has_localizations () const
 
void clear_localizations ()
 
const client::JsonCppAssociativeArray< VideoLocalizationget_localizations () const
 
client::JsonCppAssociativeArray< VideoLocalizationmutable_localizations ()
 
bool has_monetization_details () const
 
void clear_monetization_details ()
 
const VideoMonetizationDetails get_monetization_details () const
 
VideoMonetizationDetails mutable_monetizationDetails ()
 
bool has_player () const
 
void clear_player ()
 
const VideoPlayer get_player () const
 
VideoPlayer mutable_player ()
 
bool has_processing_details () const
 
void clear_processing_details ()
 
const VideoProcessingDetails get_processing_details () const
 
VideoProcessingDetails mutable_processingDetails ()
 
bool has_project_details () const
 
void clear_project_details ()
 
const VideoProjectDetails get_project_details () const
 
VideoProjectDetails mutable_projectDetails ()
 
bool has_recording_details () const
 
void clear_recording_details ()
 
const VideoRecordingDetails get_recording_details () const
 
VideoRecordingDetails mutable_recordingDetails ()
 
bool has_snippet () const
 
void clear_snippet ()
 
const VideoSnippet get_snippet () const
 
VideoSnippet mutable_snippet ()
 
bool has_statistics () const
 
void clear_statistics ()
 
const VideoStatistics get_statistics () const
 
VideoStatistics mutable_statistics ()
 
bool has_status () const
 
void clear_status ()
 
const VideoStatus get_status () const
 
VideoStatus mutable_status ()
 
bool has_suggestions () const
 
void clear_suggestions ()
 
const VideoSuggestions get_suggestions () const
 
VideoSuggestions mutable_suggestions ()
 
bool has_topic_details () const
 
void clear_topic_details ()
 
const VideoTopicDetails get_topic_details () const
 
VideoTopicDetails mutable_topicDetails ()
 

Static Public Member Functions

static VideoNew ()
 

Detailed Description

A video resource represents a YouTube video.

Constructor & Destructor Documentation

◆ Video() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ Video() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~Video()

google_youtube_api::Video::~Video ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_age_gating()

void google_youtube_api::Video::clear_age_gating ( )
inline

Clears the 'ageGating' attribute.

◆ clear_content_details()

void google_youtube_api::Video::clear_content_details ( )
inline

Clears the 'contentDetails' attribute.

◆ clear_etag()

void google_youtube_api::Video::clear_etag ( )
inline

Clears the 'etag' attribute.

◆ clear_file_details()

void google_youtube_api::Video::clear_file_details ( )
inline

Clears the 'fileDetails' attribute.

◆ clear_id()

void google_youtube_api::Video::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_youtube_api::Video::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_live_streaming_details()

void google_youtube_api::Video::clear_live_streaming_details ( )
inline

Clears the 'liveStreamingDetails' attribute.

◆ clear_localizations()

void google_youtube_api::Video::clear_localizations ( )
inline

Clears the 'localizations' attribute.

◆ clear_monetization_details()

void google_youtube_api::Video::clear_monetization_details ( )
inline

Clears the 'monetizationDetails' attribute.

◆ clear_player()

void google_youtube_api::Video::clear_player ( )
inline

Clears the 'player' attribute.

◆ clear_processing_details()

void google_youtube_api::Video::clear_processing_details ( )
inline

Clears the 'processingDetails' attribute.

◆ clear_project_details()

void google_youtube_api::Video::clear_project_details ( )
inline

Clears the 'projectDetails' attribute.

◆ clear_recording_details()

void google_youtube_api::Video::clear_recording_details ( )
inline

Clears the 'recordingDetails' attribute.

◆ clear_snippet()

void google_youtube_api::Video::clear_snippet ( )
inline

Clears the 'snippet' attribute.

◆ clear_statistics()

void google_youtube_api::Video::clear_statistics ( )
inline

Clears the 'statistics' attribute.

◆ clear_status()

void google_youtube_api::Video::clear_status ( )
inline

Clears the 'status' attribute.

◆ clear_suggestions()

void google_youtube_api::Video::clear_suggestions ( )
inline

Clears the 'suggestions' attribute.

◆ clear_topic_details()

void google_youtube_api::Video::clear_topic_details ( )
inline

Clears the 'topicDetails' attribute.

◆ get_age_gating()

const VideoAgeGating google_youtube_api::Video::get_age_gating ( ) const

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

◆ get_content_details()

const VideoContentDetails google_youtube_api::Video::get_content_details ( ) const

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

◆ get_etag()

const StringPiece google_youtube_api::Video::get_etag ( ) const
inline

Get the value of the 'etag' attribute.

◆ get_file_details()

const VideoFileDetails google_youtube_api::Video::get_file_details ( ) const

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

◆ get_id()

const StringPiece google_youtube_api::Video::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_youtube_api::Video::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_live_streaming_details()

const VideoLiveStreamingDetails google_youtube_api::Video::get_live_streaming_details ( ) const

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

◆ get_localizations()

const client::JsonCppAssociativeArray<VideoLocalization > google_youtube_api::Video::get_localizations ( ) const

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

◆ get_monetization_details()

const VideoMonetizationDetails google_youtube_api::Video::get_monetization_details ( ) const

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

◆ get_player()

const VideoPlayer google_youtube_api::Video::get_player ( ) const

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

◆ get_processing_details()

const VideoProcessingDetails google_youtube_api::Video::get_processing_details ( ) const

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

◆ get_project_details()

const VideoProjectDetails google_youtube_api::Video::get_project_details ( ) const

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

◆ get_recording_details()

const VideoRecordingDetails google_youtube_api::Video::get_recording_details ( ) const

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

◆ get_snippet()

const VideoSnippet google_youtube_api::Video::get_snippet ( ) const

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

◆ get_statistics()

const VideoStatistics google_youtube_api::Video::get_statistics ( ) const

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

◆ get_status()

const VideoStatus google_youtube_api::Video::get_status ( ) const

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

◆ get_suggestions()

const VideoSuggestions google_youtube_api::Video::get_suggestions ( ) const

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

◆ get_topic_details()

const VideoTopicDetails google_youtube_api::Video::get_topic_details ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_youtube_api::Video

◆ has_age_gating()

bool google_youtube_api::Video::has_age_gating ( ) const
inline

Determine if the 'ageGating' attribute was set.

Returns
true if the 'ageGating' attribute was set.

◆ has_content_details()

bool google_youtube_api::Video::has_content_details ( ) const
inline

Determine if the 'contentDetails' attribute was set.

Returns
true if the 'contentDetails' attribute was set.

◆ has_etag()

bool google_youtube_api::Video::has_etag ( ) const
inline

Determine if the 'etag' attribute was set.

Returns
true if the 'etag' attribute was set.

◆ has_file_details()

bool google_youtube_api::Video::has_file_details ( ) const
inline

Determine if the 'fileDetails' attribute was set.

Returns
true if the 'fileDetails' attribute was set.

◆ has_id()

bool google_youtube_api::Video::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_kind()

bool google_youtube_api::Video::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_live_streaming_details()

bool google_youtube_api::Video::has_live_streaming_details ( ) const
inline

Determine if the 'liveStreamingDetails' attribute was set.

Returns
true if the 'liveStreamingDetails' attribute was set.

◆ has_localizations()

bool google_youtube_api::Video::has_localizations ( ) const
inline

Determine if the 'localizations' attribute was set.

Returns
true if the 'localizations' attribute was set.

◆ has_monetization_details()

bool google_youtube_api::Video::has_monetization_details ( ) const
inline

Determine if the 'monetizationDetails' attribute was set.

Returns
true if the 'monetizationDetails' attribute was set.

◆ has_player()

bool google_youtube_api::Video::has_player ( ) const
inline

Determine if the 'player' attribute was set.

Returns
true if the 'player' attribute was set.

◆ has_processing_details()

bool google_youtube_api::Video::has_processing_details ( ) const
inline

Determine if the 'processingDetails' attribute was set.

Returns
true if the 'processingDetails' attribute was set.

◆ has_project_details()

bool google_youtube_api::Video::has_project_details ( ) const
inline

Determine if the 'projectDetails' attribute was set.

Returns
true if the 'projectDetails' attribute was set.

◆ has_recording_details()

bool google_youtube_api::Video::has_recording_details ( ) const
inline

Determine if the 'recordingDetails' attribute was set.

Returns
true if the 'recordingDetails' attribute was set.

◆ has_snippet()

bool google_youtube_api::Video::has_snippet ( ) const
inline

Determine if the 'snippet' attribute was set.

Returns
true if the 'snippet' attribute was set.

◆ has_statistics()

bool google_youtube_api::Video::has_statistics ( ) const
inline

Determine if the 'statistics' attribute was set.

Returns
true if the 'statistics' attribute was set.

◆ has_status()

bool google_youtube_api::Video::has_status ( ) const
inline

Determine if the 'status' attribute was set.

Returns
true if the 'status' attribute was set.

◆ has_suggestions()

bool google_youtube_api::Video::has_suggestions ( ) const
inline

Determine if the 'suggestions' attribute was set.

Returns
true if the 'suggestions' attribute was set.

◆ has_topic_details()

bool google_youtube_api::Video::has_topic_details ( ) const
inline

Determine if the 'topicDetails' attribute was set.

Returns
true if the 'topicDetails' attribute was set.

◆ mutable_ageGating()

VideoAgeGating google_youtube_api::Video::mutable_ageGating ( )

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

Age restriction details related to a video. This data can only be retrieved by the video owner.

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

◆ mutable_contentDetails()

VideoContentDetails google_youtube_api::Video::mutable_contentDetails ( )

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

The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.

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

◆ mutable_fileDetails()

VideoFileDetails google_youtube_api::Video::mutable_fileDetails ( )

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

The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.

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

◆ mutable_liveStreamingDetails()

VideoLiveStreamingDetails google_youtube_api::Video::mutable_liveStreamingDetails ( )

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

The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast.

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

◆ mutable_localizations()

client::JsonCppAssociativeArray<VideoLocalization > google_youtube_api::Video::mutable_localizations ( )

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

List with all localizations.

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

◆ mutable_monetizationDetails()

VideoMonetizationDetails google_youtube_api::Video::mutable_monetizationDetails ( )

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

The monetizationDetails object encapsulates information about the monetization status of the video.

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

◆ mutable_player()

VideoPlayer google_youtube_api::Video::mutable_player ( )

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

The player object contains information that you would use to play the video in an embedded player.

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

◆ mutable_processingDetails()

VideoProcessingDetails google_youtube_api::Video::mutable_processingDetails ( )

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

The processingDetails object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.

The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.

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

◆ mutable_projectDetails()

VideoProjectDetails google_youtube_api::Video::mutable_projectDetails ( )

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

The projectDetails object contains information about the project specific video metadata.

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

◆ mutable_recordingDetails()

VideoRecordingDetails google_youtube_api::Video::mutable_recordingDetails ( )

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

The recordingDetails object encapsulates information about the location, date and address where the video was recorded.

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

◆ mutable_snippet()

VideoSnippet google_youtube_api::Video::mutable_snippet ( )

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

The snippet object contains basic details about the video, such as its title, description, and category.

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

◆ mutable_statistics()

VideoStatistics google_youtube_api::Video::mutable_statistics ( )

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

The statistics object contains statistics about the video.

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

◆ mutable_status()

VideoStatus google_youtube_api::Video::mutable_status ( )

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

The status object contains information about the video's uploading, processing, and privacy statuses.

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

◆ mutable_suggestions()

VideoSuggestions google_youtube_api::Video::mutable_suggestions ( )

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

The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.

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

◆ mutable_topicDetails()

VideoTopicDetails google_youtube_api::Video::mutable_topicDetails ( )

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

The topicDetails object encapsulates information about Freebase topics associated with the video.

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

◆ New()

Video * google_youtube_api::Video::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_etag()

void google_youtube_api::Video::set_etag ( const StringPiece &  value)
inline

Change the 'etag' attribute.

Etag of this resource.

Parameters
[in]valueThe new value.

◆ set_id()

void google_youtube_api::Video::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

The ID that YouTube uses to uniquely identify the video.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_youtube_api::Video::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

Identifies what kind of resource this is. Value: the fixed string "youtube#video".

Parameters
[in]valueThe new value.

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