google_youtube_api::Caption Class Reference

#include <caption.h>

Inheritance diagram for google_youtube_api::Caption:

Public Member Functions
	Caption (const Json::Value &storage)
	Caption (Json::Value *storage)
virtual	~Caption ()
const StringPiece	GetTypeName () const
bool	has_etag () const
void	clear_etag ()
const StringPiece	get_etag () const
void	set_etag (const StringPiece &value)
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_snippet () const
void	clear_snippet ()
const CaptionSnippet	get_snippet () const
CaptionSnippet	mutable_snippet ()

Static Public Member Functions
static Caption *	New ()

Detailed Description

A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.

Constructor & Destructor Documentation

Caption() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Caption() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Caption()

google_youtube_api::Caption::~Caption ( )

virtual

Standard destructor.

Member Function Documentation

clear_etag()

void google_youtube_api::Caption::clear_etag ( )

inline

Clears the 'etag' attribute.

clear_id()

void google_youtube_api::Caption::clear_id ( )

inline

Clears the 'id' attribute.

clear_kind()

void google_youtube_api::Caption::clear_kind ( )

inline

Clears the 'kind' attribute.

clear_snippet()

void google_youtube_api::Caption::clear_snippet ( )

inline

Clears the 'snippet' attribute.

get_etag()

const StringPiece google_youtube_api::Caption::get_etag ( ) const

inline

Get the value of the 'etag' attribute.

get_id()

const StringPiece google_youtube_api::Caption::get_id ( ) const

inline

Get the value of the 'id' attribute.

get_kind()

const StringPiece google_youtube_api::Caption::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

get_snippet()

const CaptionSnippet google_youtube_api::Caption::get_snippet

(

)

const

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

GetTypeName()

const StringPiece google_youtube_api::Caption::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_youtube_api::Caption

has_etag()

bool google_youtube_api::Caption::has_etag ( ) const

inline

Determine if the 'etag' attribute was set.

Returns

true if the 'etag' attribute was set.

has_id()

bool google_youtube_api::Caption::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::Caption::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns

true if the 'kind' attribute was set.

has_snippet()

bool google_youtube_api::Caption::has_snippet ( ) const

inline

Determine if the 'snippet' attribute was set.

Returns

true if the 'snippet' attribute was set.

mutable_snippet()

CaptionSnippet google_youtube_api::Caption::mutable_snippet

(

)

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

The snippet object contains basic details about the caption.

Returns

The result can be modified to change the attribute value.

New()

Caption * google_youtube_api::Caption::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_etag()

void google_youtube_api::Caption::set_etag ( const StringPiece &  value )

inline

Change the 'etag' attribute.

Etag of this resource.

Parameters

[in]

value

The new value.

set_id()

void google_youtube_api::Caption::set_id ( const StringPiece &  value )

inline

Change the 'id' attribute.

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

Parameters

[in]

value

The new value.

set_kind()

void google_youtube_api::Caption::set_kind ( const StringPiece &  value )

inline

Change the 'kind' attribute.

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

Parameters

[in]

value

The new value.

---

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

• google/youtube_api/caption.h
• google/youtube_api/caption.cc