#include <you_tube_service.h>

Inheritance diagram for google_youtube_api::CaptionsResource_InsertMethod:

Public Member Functions
	CaptionsResource_InsertMethod (const YouTubeService _service_, client::AuthorizationCredential _credential_, const absl::string_view &part)

	CaptionsResource_InsertMethod (const YouTubeService _service_, client::AuthorizationCredential _credential_, const absl::string_view &part, const Caption _metadata_, const StringPiece &_media_content_type_, client::DataReader _media_content_reader_)

virtual	~CaptionsResource_InsertMethod ()

void	clear_on_behalf_of ()

const string &	get_on_behalf_of () const

string *	mutable_onBehalfOf ()

void	set_on_behalf_of (const string &value)

void	clear_on_behalf_of_content_owner ()

const string &	get_on_behalf_of_content_owner () const

string *	mutable_onBehalfOfContentOwner ()

void	set_on_behalf_of_content_owner (const string &value)

void	clear_sync ()

bool	get_sync () const

void	set_sync (bool value)

virtual util::Status	AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)

virtual util::Status	AppendOptionalQueryParameters (string *target)

util::Status	ExecuteAndParseResponse (Caption *data)

Public Member Functions inherited from google_youtube_api::YouTubeServiceBaseRequest
	YouTubeServiceBaseRequest (const client::ClientService service, client::AuthorizationCredential credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)

virtual	~YouTubeServiceBaseRequest ()

void	clear_alt ()

const string &	get_alt () const

string *	mutable_alt ()

void	set_alt (const string &value)

void	clear_fields ()

const string &	get_fields () const

string *	mutable_fields ()

void	set_fields (const string &value)

void	clear_key ()

const string &	get_key () const

string *	mutable_key ()

void	set_key (const string &value)

void	clear_oauth_token ()

const string &	get_oauth_token () const

string *	mutable_oauthToken ()

void	set_oauth_token (const string &value)

void	clear_pretty_print ()

bool	get_pretty_print () const

void	set_pretty_print (bool value)

void	clear_quota_user ()

const string &	get_quota_user () const

string *	mutable_quotaUser ()

void	set_quota_user (const string &value)

void	clear_user_ip ()

const string &	get_user_ip () const

string *	mutable_userIp ()

void	set_user_ip (const string &value)

Static Public Attributes
static const client::MediaUploadSpec	SIMPLE_MEDIA_UPLOAD

static const client::MediaUploadSpec	RESUMABLE_MEDIA_UPLOAD

Additional Inherited Members
Protected Member Functions inherited from google_youtube_api::YouTubeServiceBaseRequest
void	AddJsonContentToRequest (const client::JsonCppData *content)

Detailed Description

Implements the insert method.

This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute.

One or more of these authorization scopes are required for this method: https://www.googleapis.com/auth/youtube.force-ssl https://www.googleapis.com/auth/youtubepartner

Constructor & Destructor Documentation

◆ CaptionsResource_InsertMethod() [1/2]

google_youtube_api::CaptionsResource_InsertMethod::CaptionsResource_InsertMethod	(	const YouTubeService *	_service_,
		client::AuthorizationCredential *	_credential_,
		const absl::string_view &	part
	)

The standard constructor takes all the required method parameters.

Deprecated:: in favor constructor that includes the media upload parameters.

Parameters

[in]	<em>service</em>	The service instance to send to when executed.
[in]	<em>credential</em>	If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]	part	The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
[in]	<em>content</em>	The data object to insert.

◆ CaptionsResource_InsertMethod() [2/2]

google_youtube_api::CaptionsResource_InsertMethod::CaptionsResource_InsertMethod	(	const YouTubeService *	_service_,
		client::AuthorizationCredential *	_credential_,
		const absl::string_view &	part,
		const Caption *	_metadata_,
		const StringPiece &	_media_content_type_,
		client::DataReader *	_media_content_reader_
	)

The standard constructor takes all the required method parameters.

Parameters

[in]	<em>service</em>	The service instance to send to when executed.
[in]	<em>credential</em>	If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]	part	The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
[in]	<em>metadata</em>	The metadata object to insert. If this is NULL then do not upload any metadata.
[in]	<em>media_content_type</em>	The content type of the data in the media_content_reader.
[in]	<em>media_content_reader</em>	The media content to insert. If this is NULL then do not upload any media and ignore media_content_type.

◆ ~CaptionsResource_InsertMethod()

google_youtube_api::CaptionsResource_InsertMethod::~CaptionsResource_InsertMethod ( )

virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_youtube_api::CaptionsResource_InsertMethod::AppendOptionalQueryParameters ( string * target )

virtual

Appends the optional query parameters to the target URL.

Parameters

[in,out] target The URL string to append to.

Reimplemented from google_youtube_api::YouTubeServiceBaseRequest.

◆ AppendVariable()

util::Status google_youtube_api::CaptionsResource_InsertMethod::AppendVariable	(	const StringPiece &	variable_name,
		const client::UriTemplateConfig &	config,
		string *	target
	)

virtual

Appends variable value to the target string.

This is a helper function used to resolve templated variables in the URI.

Parameters

[in]	variable_name	The name of the templated variable.
[in]	config	A pass-through parameter used for lists and maps.
[in,out]	target	The string to append the value to.

Reimplemented from google_youtube_api::YouTubeServiceBaseRequest.

◆ clear_on_behalf_of()

void google_youtube_api::CaptionsResource_InsertMethod::clear_on_behalf_of ( )

inline

Clears the 'onBehalfOf' attribute so it is no longer set.

◆ clear_on_behalf_of_content_owner()

void google_youtube_api::CaptionsResource_InsertMethod::clear_on_behalf_of_content_owner ( )

inline

Clears the 'onBehalfOfContentOwner' attribute so it is no longer set.

◆ clear_sync()

void google_youtube_api::CaptionsResource_InsertMethod::clear_sync ( )

inline

Clears the 'sync' attribute so it is no longer set.

◆ ExecuteAndParseResponse()

util::Status google_youtube_api::CaptionsResource_InsertMethod::ExecuteAndParseResponse ( Caption * data )

inline

Executes the method and parses the response into a data object on success.

Parameters

[out] data Loads from the response payload JSON data on success.

Returns: Success if an HTTP 2xx response was received. Otherwise the status indicates the reason for failure. Finer detail may be available from the underlying http_request to distinguish the transport_status from the overal HTTP request status.

◆ get_on_behalf_of()

const string& google_youtube_api::CaptionsResource_InsertMethod::get_on_behalf_of ( ) const

inline

Gets the optional 'onBehalfOf' attribute.

If the value is not set then the default value will be returned.

◆ get_on_behalf_of_content_owner()

const string& google_youtube_api::CaptionsResource_InsertMethod::get_on_behalf_of_content_owner ( ) const

inline

Gets the optional 'onBehalfOfContentOwner' attribute.

If the value is not set then the default value will be returned.

◆ get_sync()

bool google_youtube_api::CaptionsResource_InsertMethod::get_sync ( ) const

inline

Gets the optional 'sync' attribute.

If the value is not set then the default value will be returned.

◆ mutable_onBehalfOf()

string* google_youtube_api::CaptionsResource_InsertMethod::mutable_onBehalfOf ( )

inline

Gets a modifiable pointer to the optional onBehalfOf' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ mutable_onBehalfOfContentOwner()

string* google_youtube_api::CaptionsResource_InsertMethod::mutable_onBehalfOfContentOwner ( )

inline

Gets a modifiable pointer to the optional onBehalfOfContentOwner' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ set_on_behalf_of()

void google_youtube_api::CaptionsResource_InsertMethod::set_on_behalf_of ( const string & value )

inline

Sets the 'onBehalfOf' attribute.

Parameters

[in] value ID of the Google+ Page for the channel that the request is be on behalf of.

◆ set_on_behalf_of_content_owner()

void google_youtube_api::CaptionsResource_InsertMethod::set_on_behalf_of_content_owner ( const string & value )

inline

Sets the 'onBehalfOfContentOwner' attribute.

Parameters

[in] value Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

◆ set_sync()

void google_youtube_api::CaptionsResource_InsertMethod::set_sync ( bool value )

inline

Sets the 'sync' attribute.

Parameters

[in] value The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will disregard any time codes that are in the uploaded caption file and generate new time codes for the captions.

You should set the sync parameter to true if you are uploading a transcript, which has no time codes, or if you suspect the time codes in your file are incorrect and want YouTube to try to fix them.

Member Data Documentation

◆ RESUMABLE_MEDIA_UPLOAD

const client::MediaUploadSpec google_youtube_api::CaptionsResource_InsertMethod::RESUMABLE_MEDIA_UPLOAD

static

Returns the specification for media upload using the resumable protocol.

◆ SIMPLE_MEDIA_UPLOAD

const client::MediaUploadSpec google_youtube_api::CaptionsResource_InsertMethod::SIMPLE_MEDIA_UPLOAD

static

Returns MediaUploader for uploading the content. Returns the specification for media upload using the simple protocol.

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

google/youtube_api/you_tube_service.h
google/youtube_api/you_tube_service.cc

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CaptionsResource_InsertMethod() [1/2]

◆ CaptionsResource_InsertMethod() [2/2]

◆ ~CaptionsResource_InsertMethod()

Member Function Documentation

◆ AppendOptionalQueryParameters()

◆ AppendVariable()

◆ clear_on_behalf_of()

◆ clear_on_behalf_of_content_owner()

◆ clear_sync()

◆ ExecuteAndParseResponse()

◆ get_on_behalf_of()

◆ get_on_behalf_of_content_owner()

◆ get_sync()

◆ mutable_onBehalfOf()

◆ mutable_onBehalfOfContentOwner()

◆ set_on_behalf_of()

◆ set_on_behalf_of_content_owner()

◆ set_sync()

Member Data Documentation

◆ RESUMABLE_MEDIA_UPLOAD

◆ SIMPLE_MEDIA_UPLOAD