google_youtube_api::InvideoTiming Class Reference

#include <invideo_timing.h>

Inheritance diagram for google_youtube_api::InvideoTiming:

Public Member Functions
	InvideoTiming (const Json::Value &storage)
	InvideoTiming (Json::Value *storage)
virtual	~InvideoTiming ()
const StringPiece	GetTypeName () const
bool	has_duration_ms () const
void	clear_duration_ms ()
uint64	get_duration_ms () const
void	set_duration_ms (uint64 value)
bool	has_offset_ms () const
void	clear_offset_ms ()
uint64	get_offset_ms () const
void	set_offset_ms (uint64 value)
bool	has_type () const
void	clear_type ()
const StringPiece	get_type () const
void	set_type (const StringPiece &value)

Static Public Member Functions
static InvideoTiming *	New ()

Detailed Description

Describes a temporal position of a visual widget inside a video.

Constructor & Destructor Documentation

InvideoTiming() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

InvideoTiming() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~InvideoTiming()

google_youtube_api::InvideoTiming::~InvideoTiming ( )

virtual

Standard destructor.

Member Function Documentation

clear_duration_ms()

void google_youtube_api::InvideoTiming::clear_duration_ms ( )

inline

Clears the 'durationMs' attribute.

clear_offset_ms()

void google_youtube_api::InvideoTiming::clear_offset_ms ( )

inline

Clears the 'offsetMs' attribute.

clear_type()

void google_youtube_api::InvideoTiming::clear_type ( )

inline

Clears the 'type' attribute.

get_duration_ms()

uint64 google_youtube_api::InvideoTiming::get_duration_ms ( ) const

inline

Get the value of the 'durationMs' attribute.

get_offset_ms()

uint64 google_youtube_api::InvideoTiming::get_offset_ms ( ) const

inline

Get the value of the 'offsetMs' attribute.

get_type()

const StringPiece google_youtube_api::InvideoTiming::get_type ( ) const

inline

Get the value of the 'type' attribute.

GetTypeName()

const StringPiece google_youtube_api::InvideoTiming::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_youtube_api::InvideoTiming

has_duration_ms()

bool google_youtube_api::InvideoTiming::has_duration_ms ( ) const

inline

Determine if the 'durationMs' attribute was set.

Returns

true if the 'durationMs' attribute was set.

has_offset_ms()

bool google_youtube_api::InvideoTiming::has_offset_ms ( ) const

inline

Determine if the 'offsetMs' attribute was set.

Returns

true if the 'offsetMs' attribute was set.

has_type()

bool google_youtube_api::InvideoTiming::has_type ( ) const

inline

Determine if the 'type' attribute was set.

Returns

true if the 'type' attribute was set.

New()

InvideoTiming * google_youtube_api::InvideoTiming::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_duration_ms()

void google_youtube_api::InvideoTiming::set_duration_ms ( uint64  value )

inline

Change the 'durationMs' attribute.

Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.

Parameters

[in]

value

The new value.

set_offset_ms()

void google_youtube_api::InvideoTiming::set_offset_ms ( uint64  value )

inline

Change the 'offsetMs' attribute.

Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.

Parameters

[in]

value

The new value.

set_type()

void google_youtube_api::InvideoTiming::set_type ( const StringPiece &  value )

inline

Change the 'type' attribute.

Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.

Parameters

[in]

value

The new value.

---

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

• google/youtube_api/invideo_timing.h
• google/youtube_api/invideo_timing.cc