youtube  v3
Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.YouTube.v3.CaptionsResource.InsertRequest Class Reference

Uploads a caption track. More...

Inheritance diagram for Google.Apis.YouTube.v3.CaptionsResource.InsertRequest:
Google.Apis.YouTube.v3.YouTubeBaseServiceRequest< Google.Apis.YouTube.v3.Data.Caption >

Public Member Functions

 InsertRequest (Google.Apis.Services.IClientService service, Google.Apis.YouTube.v3.Data.Caption body, string part)
 Constructs a new Insert request. More...
 

Protected Member Functions

override object GetBody ()
 summary>Gets the method name. More...
 
override void InitParameters ()
 Initializes Insert parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.YouTube.v3.YouTubeBaseServiceRequest< Google.Apis.YouTube.v3.Data.Caption >
 YouTubeBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new YouTubeBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes YouTube parameter list. More...
 

Properties

virtual string Part [get]
 The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet. More...
 
virtual string OnBehalfOf [get, set]
 ID of the Google+ Page for the channel that the request is be on behalf of More...
 
virtual string OnBehalfOfContentOwner [get, set]
 Note: This parameter is intended exclusively for YouTube content partners. More...
 
virtual System.Nullable< bool > Sync [get, set]
 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. More...
 
override string MethodName [get]
 summary>Gets the HTTP method. More...
 
override string HttpMethod [get]
 summary>Gets the REST path. More...
 
override string RestPath [get]
 
- Properties inherited from Google.Apis.YouTube.v3.YouTubeBaseServiceRequest< Google.Apis.YouTube.v3.Data.Caption >
virtual System.Nullable< AltEnum > Alt [get, set]
 Data format for the response. More...
 
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response. More...
 
virtual string Key [get, set]
 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. More...
 
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user. More...
 
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks. More...
 
virtual string QuotaUser [get, set]
 An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More...
 
virtual string UserIp [get, set]
 Deprecated. Please use quotaUser instead. More...
 

Detailed Description

Uploads a caption track.

Constructor & Destructor Documentation

◆ InsertRequest()

Google.Apis.YouTube.v3.CaptionsResource.InsertRequest.InsertRequest ( Google.Apis.Services.IClientService  service,
Google.Apis.YouTube.v3.Data.Caption  body,
string  part 
)
inline

Constructs a new Insert request.

Member Function Documentation

◆ GetBody()

override object Google.Apis.YouTube.v3.CaptionsResource.InsertRequest.GetBody ( )
inlineprotected

summary>Gets the method name.

◆ InitParameters()

override void Google.Apis.YouTube.v3.CaptionsResource.InsertRequest.InitParameters ( )
inlineprotected

Initializes Insert parameter list.

Property Documentation

◆ HttpMethod

override string Google.Apis.YouTube.v3.CaptionsResource.InsertRequest.HttpMethod
get

summary>Gets the REST path.

◆ MethodName

override string Google.Apis.YouTube.v3.CaptionsResource.InsertRequest.MethodName
get

summary>Gets the HTTP method.

◆ OnBehalfOf

virtual string Google.Apis.YouTube.v3.CaptionsResource.InsertRequest.OnBehalfOf
getset

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

◆ OnBehalfOfContentOwner

virtual string Google.Apis.YouTube.v3.CaptionsResource.InsertRequest.OnBehalfOfContentOwner
getset

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.

◆ Part

virtual string Google.Apis.YouTube.v3.CaptionsResource.InsertRequest.Part
get

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

◆ Sync

virtual System.Nullable<bool> Google.Apis.YouTube.v3.CaptionsResource.InsertRequest.Sync
getset

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.


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