google_youtube_api::VideoProcessingDetailsProcessingProgress Class Reference

#include <video_processing_details_processing_progress.h>

Inheritance diagram for google_youtube_api::VideoProcessingDetailsProcessingProgress:

Public Member Functions
	VideoProcessingDetailsProcessingProgress (const Json::Value &storage)
	VideoProcessingDetailsProcessingProgress (Json::Value *storage)
virtual	~VideoProcessingDetailsProcessingProgress ()
const StringPiece	GetTypeName () const
bool	has_parts_processed () const
void	clear_parts_processed ()
uint64	get_parts_processed () const
void	set_parts_processed (uint64 value)
bool	has_parts_total () const
void	clear_parts_total ()
uint64	get_parts_total () const
void	set_parts_total (uint64 value)
bool	has_time_left_ms () const
void	clear_time_left_ms ()
uint64	get_time_left_ms () const
void	set_time_left_ms (uint64 value)

Static Public Member Functions
static VideoProcessingDetailsProcessingProgress *	New ()

Detailed Description

Video processing progress and completion time estimate.

Constructor & Destructor Documentation

VideoProcessingDetailsProcessingProgress() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

VideoProcessingDetailsProcessingProgress() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~VideoProcessingDetailsProcessingProgress()

google_youtube_api::VideoProcessingDetailsProcessingProgress::~VideoProcessingDetailsProcessingProgress ( )

virtual

Standard destructor.

Member Function Documentation

clear_parts_processed()

void google_youtube_api::VideoProcessingDetailsProcessingProgress::clear_parts_processed ( )

inline

Clears the 'partsProcessed' attribute.

clear_parts_total()

void google_youtube_api::VideoProcessingDetailsProcessingProgress::clear_parts_total ( )

inline

Clears the 'partsTotal' attribute.

clear_time_left_ms()

void google_youtube_api::VideoProcessingDetailsProcessingProgress::clear_time_left_ms ( )

inline

Clears the 'timeLeftMs' attribute.

get_parts_processed()

uint64 google_youtube_api::VideoProcessingDetailsProcessingProgress::get_parts_processed ( ) const

inline

Get the value of the 'partsProcessed' attribute.

get_parts_total()

uint64 google_youtube_api::VideoProcessingDetailsProcessingProgress::get_parts_total ( ) const

inline

Get the value of the 'partsTotal' attribute.

get_time_left_ms()

uint64 google_youtube_api::VideoProcessingDetailsProcessingProgress::get_time_left_ms ( ) const

inline

Get the value of the 'timeLeftMs' attribute.

GetTypeName()

const StringPiece google_youtube_api::VideoProcessingDetailsProcessingProgress::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_youtube_api::VideoProcessingDetailsProcessingProgress

has_parts_processed()

bool google_youtube_api::VideoProcessingDetailsProcessingProgress::has_parts_processed ( ) const

inline

Determine if the 'partsProcessed' attribute was set.

Returns

true if the 'partsProcessed' attribute was set.

has_parts_total()

bool google_youtube_api::VideoProcessingDetailsProcessingProgress::has_parts_total ( ) const

inline

Determine if the 'partsTotal' attribute was set.

Returns

true if the 'partsTotal' attribute was set.

has_time_left_ms()

bool google_youtube_api::VideoProcessingDetailsProcessingProgress::has_time_left_ms ( ) const

inline

Determine if the 'timeLeftMs' attribute was set.

Returns

true if the 'timeLeftMs' attribute was set.

New()

VideoProcessingDetailsProcessingProgress * google_youtube_api::VideoProcessingDetailsProcessingProgress::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_parts_processed()

void google_youtube_api::VideoProcessingDetailsProcessingProgress::set_parts_processed ( uint64  value )

inline

Change the 'partsProcessed' attribute.

The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating: 100 * parts_processed / parts_total

Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.

Parameters

[in]

value

The new value.

set_parts_total()

void google_youtube_api::VideoProcessingDetailsProcessingProgress::set_parts_total ( uint64  value )

inline

Change the 'partsTotal' attribute.

An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.

Parameters

[in]

value

The new value.

set_time_left_ms()

void google_youtube_api::VideoProcessingDetailsProcessingProgress::set_time_left_ms ( uint64  value )

inline

Change the 'timeLeftMs' attribute.

An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.

Parameters

[in]

value

The new value.

---

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

• google/youtube_api/video_processing_details_processing_progress.h
• google/youtube_api/video_processing_details_processing_progress.cc