Struct google_youtube3::CaptionInsertCall [] [src]

pub struct CaptionInsertCall<'a, C, A> where
    C: 'a,
    A: 'a, 
{ /* fields omitted */ }

Uploads a caption track.

A builder for the insert method supported by a caption resource. It is not used directly, but through a CaptionMethods instance.


Instantiate a resource method builder

use youtube3::Caption;
use std::fs;
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Caption::default();
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `upload_resumable(...)`.
// Values shown here are possibly random and not representative !
let result = hub.captions().insert(req)
             .upload_resumable(fs::File::open("file.ext").unwrap(), "application/octet-stream".parse().unwrap());


impl<'a, C, A> CaptionInsertCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken

Upload media all at once. If the upload fails for whichever reason, all progress is lost.

  • max size: 100MB
  • multipart: yes
  • valid mime types: '*/*', 'application/octet-stream' and 'text/xml'

Upload media in a resumable fashion. Even if the upload fails or is interrupted, it can be resumed for a certain amount of time as the server maintains state temporarily.

The delegate will be asked for an upload_url(), and if not provided, will be asked to store an upload URL that was provided by the server, using store_upload_url(...). The upload will be done in chunks, the delegate may specify the chunk_size() and may cancel the operation before each chunk is uploaded, using cancel_chunk_upload(...).

  • max size: 100MB
  • multipart: yes
  • valid mime types: '*/*', 'application/octet-stream' and 'text/xml'

Sets the request property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.

Sets the part query property to the given value.

Even though the parts list is automatically derived from Resource passed in during instantiation and indicates which values you are passing, the response would contain the very same parts. This may not always be desirable, as you can obtain (newly generated) parts you cannot pass in, like statistics that are generated server side. Therefore you should use this method to specify the parts you provide in addition to the ones you want in the response.

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.

Sets the sync query property to the given 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.

Sets the on behalf of content owner query property to the given value.

ID of the Google+ Page for the channel that the request is be on behalf of

Sets the on behalf of query property to the given value.

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known paramters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

  • quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  • oauth_token (query-string) - OAuth 2.0 token for the current user.
  • key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • prettyPrint (query-boolean) - Returns response with indentations and line breaks.
  • userIp (query-string) - IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  • fields (query-string) - Selector specifying which fields to include in a partial response.
  • alt (query-string) - Data format for the response.

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::ForceSsl.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope.

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

impl<'a, C, A> CallBuilder for CaptionInsertCall<'a, C, A>