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

#include <video_content_details.h>

Inheritance diagram for google_youtube_api::VideoContentDetails:

Public Member Functions

 VideoContentDetails (const Json::Value &storage)
 
 VideoContentDetails (Json::Value *storage)
 
virtual ~VideoContentDetails ()
 
const StringPiece GetTypeName () const
 
bool has_caption () const
 
void clear_caption ()
 
const StringPiece get_caption () const
 
void set_caption (const StringPiece &value)
 
bool has_content_rating () const
 
void clear_content_rating ()
 
const ContentRating get_content_rating () const
 
ContentRating mutable_contentRating ()
 
bool has_country_restriction () const
 
void clear_country_restriction ()
 
const AccessPolicy get_country_restriction () const
 
AccessPolicy mutable_countryRestriction ()
 
bool has_definition () const
 
void clear_definition ()
 
const StringPiece get_definition () const
 
void set_definition (const StringPiece &value)
 
bool has_dimension () const
 
void clear_dimension ()
 
const StringPiece get_dimension () const
 
void set_dimension (const StringPiece &value)
 
bool has_duration () const
 
void clear_duration ()
 
const StringPiece get_duration () const
 
void set_duration (const StringPiece &value)
 
bool has_has_custom_thumbnail () const
 
void clear_has_custom_thumbnail ()
 
bool get_has_custom_thumbnail () const
 
void set_has_custom_thumbnail (bool value)
 
bool has_licensed_content () const
 
void clear_licensed_content ()
 
bool get_licensed_content () const
 
void set_licensed_content (bool value)
 
bool has_projection () const
 
void clear_projection ()
 
const StringPiece get_projection () const
 
void set_projection (const StringPiece &value)
 
bool has_region_restriction () const
 
void clear_region_restriction ()
 
const VideoContentDetailsRegionRestriction get_region_restriction () const
 
VideoContentDetailsRegionRestriction mutable_regionRestriction ()
 

Static Public Member Functions

static VideoContentDetailsNew ()
 

Detailed Description

Details about the content of a YouTube Video.

Constructor & Destructor Documentation

◆ VideoContentDetails() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ VideoContentDetails() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~VideoContentDetails()

google_youtube_api::VideoContentDetails::~VideoContentDetails ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_caption()

void google_youtube_api::VideoContentDetails::clear_caption ( )
inline

Clears the 'caption' attribute.

◆ clear_content_rating()

void google_youtube_api::VideoContentDetails::clear_content_rating ( )
inline

Clears the 'contentRating' attribute.

◆ clear_country_restriction()

void google_youtube_api::VideoContentDetails::clear_country_restriction ( )
inline

Clears the 'countryRestriction' attribute.

◆ clear_definition()

void google_youtube_api::VideoContentDetails::clear_definition ( )
inline

Clears the 'definition' attribute.

◆ clear_dimension()

void google_youtube_api::VideoContentDetails::clear_dimension ( )
inline

Clears the 'dimension' attribute.

◆ clear_duration()

void google_youtube_api::VideoContentDetails::clear_duration ( )
inline

Clears the 'duration' attribute.

◆ clear_has_custom_thumbnail()

void google_youtube_api::VideoContentDetails::clear_has_custom_thumbnail ( )
inline

Clears the 'hasCustomThumbnail' attribute.

◆ clear_licensed_content()

void google_youtube_api::VideoContentDetails::clear_licensed_content ( )
inline

Clears the 'licensedContent' attribute.

◆ clear_projection()

void google_youtube_api::VideoContentDetails::clear_projection ( )
inline

Clears the 'projection' attribute.

◆ clear_region_restriction()

void google_youtube_api::VideoContentDetails::clear_region_restriction ( )
inline

Clears the 'regionRestriction' attribute.

◆ get_caption()

const StringPiece google_youtube_api::VideoContentDetails::get_caption ( ) const
inline

Get the value of the 'caption' attribute.

◆ get_content_rating()

const ContentRating google_youtube_api::VideoContentDetails::get_content_rating ( ) const

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

◆ get_country_restriction()

const AccessPolicy google_youtube_api::VideoContentDetails::get_country_restriction ( ) const

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

◆ get_definition()

const StringPiece google_youtube_api::VideoContentDetails::get_definition ( ) const
inline

Get the value of the 'definition' attribute.

◆ get_dimension()

const StringPiece google_youtube_api::VideoContentDetails::get_dimension ( ) const
inline

Get the value of the 'dimension' attribute.

◆ get_duration()

const StringPiece google_youtube_api::VideoContentDetails::get_duration ( ) const
inline

Get the value of the 'duration' attribute.

◆ get_has_custom_thumbnail()

bool google_youtube_api::VideoContentDetails::get_has_custom_thumbnail ( ) const
inline

Get the value of the 'hasCustomThumbnail' attribute.

◆ get_licensed_content()

bool google_youtube_api::VideoContentDetails::get_licensed_content ( ) const
inline

Get the value of the 'licensedContent' attribute.

◆ get_projection()

const StringPiece google_youtube_api::VideoContentDetails::get_projection ( ) const
inline

Get the value of the 'projection' attribute.

◆ get_region_restriction()

const VideoContentDetailsRegionRestriction google_youtube_api::VideoContentDetails::get_region_restriction ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_youtube_api::VideoContentDetails

◆ has_caption()

bool google_youtube_api::VideoContentDetails::has_caption ( ) const
inline

Determine if the 'caption' attribute was set.

Returns
true if the 'caption' attribute was set.

◆ has_content_rating()

bool google_youtube_api::VideoContentDetails::has_content_rating ( ) const
inline

Determine if the 'contentRating' attribute was set.

Returns
true if the 'contentRating' attribute was set.

◆ has_country_restriction()

bool google_youtube_api::VideoContentDetails::has_country_restriction ( ) const
inline

Determine if the 'countryRestriction' attribute was set.

Returns
true if the 'countryRestriction' attribute was set.

◆ has_definition()

bool google_youtube_api::VideoContentDetails::has_definition ( ) const
inline

Determine if the 'definition' attribute was set.

Returns
true if the 'definition' attribute was set.

◆ has_dimension()

bool google_youtube_api::VideoContentDetails::has_dimension ( ) const
inline

Determine if the 'dimension' attribute was set.

Returns
true if the 'dimension' attribute was set.

◆ has_duration()

bool google_youtube_api::VideoContentDetails::has_duration ( ) const
inline

Determine if the 'duration' attribute was set.

Returns
true if the 'duration' attribute was set.

◆ has_has_custom_thumbnail()

bool google_youtube_api::VideoContentDetails::has_has_custom_thumbnail ( ) const
inline

Determine if the 'hasCustomThumbnail' attribute was set.

Returns
true if the 'hasCustomThumbnail' attribute was set.

◆ has_licensed_content()

bool google_youtube_api::VideoContentDetails::has_licensed_content ( ) const
inline

Determine if the 'licensedContent' attribute was set.

Returns
true if the 'licensedContent' attribute was set.

◆ has_projection()

bool google_youtube_api::VideoContentDetails::has_projection ( ) const
inline

Determine if the 'projection' attribute was set.

Returns
true if the 'projection' attribute was set.

◆ has_region_restriction()

bool google_youtube_api::VideoContentDetails::has_region_restriction ( ) const
inline

Determine if the 'regionRestriction' attribute was set.

Returns
true if the 'regionRestriction' attribute was set.

◆ mutable_contentRating()

ContentRating google_youtube_api::VideoContentDetails::mutable_contentRating ( )

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

Specifies the ratings that the video received under various rating schemes.

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

◆ mutable_countryRestriction()

AccessPolicy google_youtube_api::VideoContentDetails::mutable_countryRestriction ( )

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

The countryRestriction object contains information about the countries where a video is (or is not) viewable.

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

◆ mutable_regionRestriction()

VideoContentDetailsRegionRestriction google_youtube_api::VideoContentDetails::mutable_regionRestriction ( )

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

The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.

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

◆ New()

VideoContentDetails * google_youtube_api::VideoContentDetails::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_caption()

void google_youtube_api::VideoContentDetails::set_caption ( const StringPiece &  value)
inline

Change the 'caption' attribute.

The value of captions indicates whether the video has captions or not.

Parameters
[in]valueThe new value.

◆ set_definition()

void google_youtube_api::VideoContentDetails::set_definition ( const StringPiece &  value)
inline

Change the 'definition' attribute.

The value of definition indicates whether the video is available in high definition or only in standard definition.

Parameters
[in]valueThe new value.

◆ set_dimension()

void google_youtube_api::VideoContentDetails::set_dimension ( const StringPiece &  value)
inline

Change the 'dimension' attribute.

The value of dimension indicates whether the video is available in 3D or in 2D.

Parameters
[in]valueThe new value.

◆ set_duration()

void google_youtube_api::VideoContentDetails::set_duration ( const StringPiece &  value)
inline

Change the 'duration' attribute.

The length of the video. The tag value is an ISO 8601 duration in the format PT::M::S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.

Parameters
[in]valueThe new value.

◆ set_has_custom_thumbnail()

void google_youtube_api::VideoContentDetails::set_has_custom_thumbnail ( bool  value)
inline

Change the 'hasCustomThumbnail' attribute.

Indicates whether the video uploader has provided a custom thumbnail image for the video. This property is only visible to the video uploader.

Parameters
[in]valueThe new value.

◆ set_licensed_content()

void google_youtube_api::VideoContentDetails::set_licensed_content ( bool  value)
inline

Change the 'licensedContent' attribute.

The value of is_license_content indicates whether the video is licensed content.

Parameters
[in]valueThe new value.

◆ set_projection()

void google_youtube_api::VideoContentDetails::set_projection ( const StringPiece &  value)
inline

Change the 'projection' attribute.

Specifies the projection format of the video.

Parameters
[in]valueThe new value.

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