#include <caption_snippet.h>

Inheritance diagram for google_youtube_api::CaptionSnippet:

Public Member Functions
	CaptionSnippet (const Json::Value &storage)

	CaptionSnippet (Json::Value *storage)

virtual	~CaptionSnippet ()

const StringPiece	GetTypeName () const

bool	has_audio_track_type () const

void	clear_audio_track_type ()

const StringPiece	get_audio_track_type () const

void	set_audio_track_type (const StringPiece &value)

bool	has_failure_reason () const

void	clear_failure_reason ()

const StringPiece	get_failure_reason () const

void	set_failure_reason (const StringPiece &value)

bool	has_is_auto_synced () const

void	clear_is_auto_synced ()

bool	get_is_auto_synced () const

void	set_is_auto_synced (bool value)

bool	has_is_cc () const

void	clear_is_cc ()

bool	get_is_cc () const

void	set_is_cc (bool value)

bool	has_is_draft () const

void	clear_is_draft ()

bool	get_is_draft () const

void	set_is_draft (bool value)

bool	has_is_easy_reader () const

void	clear_is_easy_reader ()

bool	get_is_easy_reader () const

void	set_is_easy_reader (bool value)

bool	has_is_large () const

void	clear_is_large ()

bool	get_is_large () const

void	set_is_large (bool value)

bool	has_language () const

void	clear_language ()

const StringPiece	get_language () const

void	set_language (const StringPiece &value)

bool	has_last_updated () const

void	clear_last_updated ()

client::DateTime	get_last_updated () const

void	set_last_updated (client::DateTime value)

bool	has_name () const

void	clear_name ()

const StringPiece	get_name () const

void	set_name (const StringPiece &value)

bool	has_status () const

void	clear_status ()

const StringPiece	get_status () const

void	set_status (const StringPiece &value)

bool	has_track_kind () const

void	clear_track_kind ()

const StringPiece	get_track_kind () const

void	set_track_kind (const StringPiece &value)

bool	has_video_id () const

void	clear_video_id ()

const StringPiece	get_video_id () const

void	set_video_id (const StringPiece &value)

Static Public Member Functions
static CaptionSnippet *	New ()

Detailed Description

Basic details about a caption track, such as its language and name.

Constructor & Destructor Documentation

◆ CaptionSnippet() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ CaptionSnippet() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~CaptionSnippet()

google_youtube_api::CaptionSnippet::~CaptionSnippet ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_audio_track_type()

void google_youtube_api::CaptionSnippet::clear_audio_track_type ( )

inline

Clears the 'audioTrackType' attribute.

◆ clear_failure_reason()

void google_youtube_api::CaptionSnippet::clear_failure_reason ( )

inline

Clears the 'failureReason' attribute.

◆ clear_is_auto_synced()

void google_youtube_api::CaptionSnippet::clear_is_auto_synced ( )

inline

Clears the 'isAutoSynced' attribute.

◆ clear_is_cc()

void google_youtube_api::CaptionSnippet::clear_is_cc ( )

inline

Clears the 'isCC' attribute.

◆ clear_is_draft()

void google_youtube_api::CaptionSnippet::clear_is_draft ( )

inline

Clears the 'isDraft' attribute.

◆ clear_is_easy_reader()

void google_youtube_api::CaptionSnippet::clear_is_easy_reader ( )

inline

Clears the 'isEasyReader' attribute.

◆ clear_is_large()

void google_youtube_api::CaptionSnippet::clear_is_large ( )

inline

Clears the 'isLarge' attribute.

◆ clear_language()

void google_youtube_api::CaptionSnippet::clear_language ( )

inline

Clears the 'language' attribute.

◆ clear_last_updated()

void google_youtube_api::CaptionSnippet::clear_last_updated ( )

inline

Clears the 'lastUpdated' attribute.

◆ clear_name()

void google_youtube_api::CaptionSnippet::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_status()

void google_youtube_api::CaptionSnippet::clear_status ( )

inline

Clears the 'status' attribute.

◆ clear_track_kind()

void google_youtube_api::CaptionSnippet::clear_track_kind ( )

inline

Clears the 'trackKind' attribute.

◆ clear_video_id()

void google_youtube_api::CaptionSnippet::clear_video_id ( )

inline

Clears the 'videoId' attribute.

◆ get_audio_track_type()

const StringPiece google_youtube_api::CaptionSnippet::get_audio_track_type ( ) const

inline

Get the value of the 'audioTrackType' attribute.

◆ get_failure_reason()

const StringPiece google_youtube_api::CaptionSnippet::get_failure_reason ( ) const

inline

Get the value of the 'failureReason' attribute.

◆ get_is_auto_synced()

bool google_youtube_api::CaptionSnippet::get_is_auto_synced ( ) const

inline

Get the value of the 'isAutoSynced' attribute.

◆ get_is_cc()

bool google_youtube_api::CaptionSnippet::get_is_cc ( ) const

inline

Get the value of the 'isCC' attribute.

◆ get_is_draft()

bool google_youtube_api::CaptionSnippet::get_is_draft ( ) const

inline

Get the value of the 'isDraft' attribute.

◆ get_is_easy_reader()

bool google_youtube_api::CaptionSnippet::get_is_easy_reader ( ) const

inline

Get the value of the 'isEasyReader' attribute.

◆ get_is_large()

bool google_youtube_api::CaptionSnippet::get_is_large ( ) const

inline

Get the value of the 'isLarge' attribute.

◆ get_language()

const StringPiece google_youtube_api::CaptionSnippet::get_language ( ) const

inline

Get the value of the 'language' attribute.

◆ get_last_updated()

client::DateTime google_youtube_api::CaptionSnippet::get_last_updated ( ) const

inline

Get the value of the 'lastUpdated' attribute.

◆ get_name()

const StringPiece google_youtube_api::CaptionSnippet::get_name ( ) const

inline

Get the value of the 'name' attribute.

◆ get_status()

const StringPiece google_youtube_api::CaptionSnippet::get_status ( ) const

inline

Get the value of the 'status' attribute.

◆ get_track_kind()

const StringPiece google_youtube_api::CaptionSnippet::get_track_kind ( ) const

inline

Get the value of the 'trackKind' attribute.

◆ get_video_id()

const StringPiece google_youtube_api::CaptionSnippet::get_video_id ( ) const

inline

Get the value of the 'videoId' attribute.

◆ GetTypeName()

const StringPiece google_youtube_api::CaptionSnippet::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_youtube_api::CaptionSnippet

◆ has_audio_track_type()

bool google_youtube_api::CaptionSnippet::has_audio_track_type ( ) const

inline

Determine if the 'audioTrackType' attribute was set.

Returns: true if the 'audioTrackType' attribute was set.

◆ has_failure_reason()

bool google_youtube_api::CaptionSnippet::has_failure_reason ( ) const

inline

Determine if the 'failureReason' attribute was set.

Returns: true if the 'failureReason' attribute was set.

◆ has_is_auto_synced()

bool google_youtube_api::CaptionSnippet::has_is_auto_synced ( ) const

inline

Determine if the 'isAutoSynced' attribute was set.

Returns: true if the 'isAutoSynced' attribute was set.

◆ has_is_cc()

bool google_youtube_api::CaptionSnippet::has_is_cc ( ) const

inline

Determine if the 'isCC' attribute was set.

Returns: true if the 'isCC' attribute was set.

◆ has_is_draft()

bool google_youtube_api::CaptionSnippet::has_is_draft ( ) const

inline

Determine if the 'isDraft' attribute was set.

Returns: true if the 'isDraft' attribute was set.

◆ has_is_easy_reader()

bool google_youtube_api::CaptionSnippet::has_is_easy_reader ( ) const

inline

Determine if the 'isEasyReader' attribute was set.

Returns: true if the 'isEasyReader' attribute was set.

◆ has_is_large()

bool google_youtube_api::CaptionSnippet::has_is_large ( ) const

inline

Determine if the 'isLarge' attribute was set.

Returns: true if the 'isLarge' attribute was set.

◆ has_language()

bool google_youtube_api::CaptionSnippet::has_language ( ) const

inline

Determine if the 'language' attribute was set.

Returns: true if the 'language' attribute was set.

◆ has_last_updated()

bool google_youtube_api::CaptionSnippet::has_last_updated ( ) const

inline

Determine if the 'lastUpdated' attribute was set.

Returns: true if the 'lastUpdated' attribute was set.

◆ has_name()

bool google_youtube_api::CaptionSnippet::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns: true if the 'name' attribute was set.

◆ has_status()

bool google_youtube_api::CaptionSnippet::has_status ( ) const

inline

Determine if the 'status' attribute was set.

Returns: true if the 'status' attribute was set.

◆ has_track_kind()

bool google_youtube_api::CaptionSnippet::has_track_kind ( ) const

inline

Determine if the 'trackKind' attribute was set.

Returns: true if the 'trackKind' attribute was set.

◆ has_video_id()

bool google_youtube_api::CaptionSnippet::has_video_id ( ) const

inline

Determine if the 'videoId' attribute was set.

Returns: true if the 'videoId' attribute was set.

◆ New()

CaptionSnippet * google_youtube_api::CaptionSnippet::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_audio_track_type()

void google_youtube_api::CaptionSnippet::set_audio_track_type ( const StringPiece & value )

inline

Change the 'audioTrackType' attribute.

The type of audio track associated with the caption track.

Parameters

[in] value The new value.

◆ set_failure_reason()

void google_youtube_api::CaptionSnippet::set_failure_reason ( const StringPiece & value )

inline

Change the 'failureReason' attribute.

The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.

Parameters

[in] value The new value.

◆ set_is_auto_synced()

void google_youtube_api::CaptionSnippet::set_is_auto_synced ( bool value )

inline

Change the 'isAutoSynced' attribute.

Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.

Parameters

[in] value The new value.

◆ set_is_cc()

void google_youtube_api::CaptionSnippet::set_is_cc ( bool value )

inline

Change the 'isCC' attribute.

Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.

Parameters

[in] value The new value.

◆ set_is_draft()

void google_youtube_api::CaptionSnippet::set_is_draft ( bool value )

inline

Change the 'isDraft' attribute.

Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.

Parameters

[in] value The new value.

◆ set_is_easy_reader()

void google_youtube_api::CaptionSnippet::set_is_easy_reader ( bool value )

inline

Change the 'isEasyReader' attribute.

Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.

Parameters

[in] value The new value.

◆ set_is_large()

void google_youtube_api::CaptionSnippet::set_is_large ( bool value )

inline

Change the 'isLarge' attribute.

Indicates whether the caption track uses large text for the vision- impaired. The default value is false.

Parameters

[in] value The new value.

◆ set_language()

void google_youtube_api::CaptionSnippet::set_language ( const StringPiece & value )

inline

Change the 'language' attribute.

The language of the caption track. The property value is a BCP-47 language tag.

Parameters

[in] value The new value.

◆ set_last_updated()

void google_youtube_api::CaptionSnippet::set_last_updated ( client::DateTime value )

inline

Change the 'lastUpdated' attribute.

The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

Parameters

[in] value The new value.

◆ set_name()

void google_youtube_api::CaptionSnippet::set_name ( const StringPiece & value )

inline

Change the 'name' attribute.

The name of the caption track. The name is intended to be visible to the user as an option during playback.

Parameters

[in] value The new value.

◆ set_status()

void google_youtube_api::CaptionSnippet::set_status ( const StringPiece & value )

inline

Change the 'status' attribute.

The caption track's status.

Parameters

[in] value The new value.

◆ set_track_kind()

void google_youtube_api::CaptionSnippet::set_track_kind ( const StringPiece & value )

inline

Change the 'trackKind' attribute.

The caption track's type.

Parameters

[in] value The new value.

◆ set_video_id()

void google_youtube_api::CaptionSnippet::set_video_id ( const StringPiece & value )

inline

Change the 'videoId' attribute.

The ID that YouTube uses to uniquely identify the video associated with the caption track.

Parameters

[in] value The new value.

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

google/youtube_api/caption_snippet.h
google/youtube_api/caption_snippet.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CaptionSnippet() [1/2]

◆ CaptionSnippet() [2/2]

◆ ~CaptionSnippet()

Member Function Documentation

◆ clear_audio_track_type()

◆ clear_failure_reason()

◆ clear_is_auto_synced()

◆ clear_is_cc()

◆ clear_is_draft()

◆ clear_is_easy_reader()

◆ clear_is_large()

◆ clear_language()

◆ clear_last_updated()

◆ clear_name()

◆ clear_status()

◆ clear_track_kind()

◆ clear_video_id()

◆ get_audio_track_type()

◆ get_failure_reason()

◆ get_is_auto_synced()

◆ get_is_cc()

◆ get_is_draft()

◆ get_is_easy_reader()

◆ get_is_large()

◆ get_language()

◆ get_last_updated()

◆ get_name()

◆ get_status()

◆ get_track_kind()

◆ get_video_id()

◆ GetTypeName()

◆ has_audio_track_type()

◆ has_failure_reason()

◆ has_is_auto_synced()

◆ has_is_cc()

◆ has_is_draft()

◆ has_is_easy_reader()

◆ has_is_large()

◆ has_language()

◆ has_last_updated()

◆ has_name()

◆ has_status()

◆ has_track_kind()

◆ has_video_id()

◆ New()

◆ set_audio_track_type()

◆ set_failure_reason()

◆ set_is_auto_synced()

◆ set_is_cc()

◆ set_is_draft()

◆ set_is_easy_reader()

◆ set_is_large()

◆ set_language()

◆ set_last_updated()

◆ set_name()

◆ set_status()

◆ set_track_kind()

◆ set_video_id()