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

Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter. More...

Inheritance diagram for Google.Apis.YouTube.v3.CaptionsResource.DownloadRequest:
Google.Apis.YouTube.v3.YouTubeBaseServiceRequest< string >

Public Types

enum  TfmtEnum {
  TfmtEnum.Sbv, TfmtEnum.Scc, TfmtEnum.Srt, TfmtEnum.Ttml,
  TfmtEnum.Vtt
}
 The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format. More...
 

Public Member Functions

 DownloadRequest (Google.Apis.Services.IClientService service, string id)
 Constructs a new Download request. More...
 
virtual void Download (System.IO.Stream stream)
 Synchronously download the media into the given stream. More...
 
virtual System.Threading.Tasks.Task< Google.Apis.Download.IDownloadProgressDownloadAsync (System.IO.Stream stream)
 Asynchronously download the media into the given stream. More...
 
virtual System.Threading.Tasks.Task< Google.Apis.Download.IDownloadProgressDownloadAsync (System.IO.Stream stream, System.Threading.CancellationToken cancellationToken)
 Asynchronously download the media into the given stream. More...
 

Protected Member Functions

override void InitParameters ()
 Initializes Download parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.YouTube.v3.YouTubeBaseServiceRequest< string >
 YouTubeBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new YouTubeBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes YouTube parameter list. More...
 

Properties

virtual string Id [get]
 The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource. 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< TfmtEnumTfmt [get, set]
 The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format. More...
 
virtual string Tlang [get, set]
 The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate. 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]
 
Google.Apis.Download.IMediaDownloader MediaDownloader [get]
 Gets the media downloader. More...
 
- Properties inherited from Google.Apis.YouTube.v3.YouTubeBaseServiceRequest< string >
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

Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.

Member Enumeration Documentation

◆ TfmtEnum

The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format.

Enumerator
Sbv 

SubViewer subtitle.

Scc 

Scenarist Closed Caption format.

Srt 

SubRip subtitle.

Ttml 

Timed Text Markup Language caption.

Vtt 

Web Video Text Tracks caption.

Constructor & Destructor Documentation

◆ DownloadRequest()

Google.Apis.YouTube.v3.CaptionsResource.DownloadRequest.DownloadRequest ( Google.Apis.Services.IClientService  service,
string  id 
)
inline

Constructs a new Download request.

Member Function Documentation

◆ Download()

virtual void Google.Apis.YouTube.v3.CaptionsResource.DownloadRequest.Download ( System.IO.Stream  stream)
inlinevirtual

Synchronously download the media into the given stream.

◆ DownloadAsync() [1/2]

virtual System.Threading.Tasks.Task<Google.Apis.Download.IDownloadProgress> Google.Apis.YouTube.v3.CaptionsResource.DownloadRequest.DownloadAsync ( System.IO.Stream  stream)
inlinevirtual

Asynchronously download the media into the given stream.

◆ DownloadAsync() [2/2]

virtual System.Threading.Tasks.Task<Google.Apis.Download.IDownloadProgress> Google.Apis.YouTube.v3.CaptionsResource.DownloadRequest.DownloadAsync ( System.IO.Stream  stream,
System.Threading.CancellationToken  cancellationToken 
)
inlinevirtual

Asynchronously download the media into the given stream.

◆ InitParameters()

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

Initializes Download parameter list.

Property Documentation

◆ HttpMethod

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

summary>Gets the REST path.

◆ Id

virtual string Google.Apis.YouTube.v3.CaptionsResource.DownloadRequest.Id
get

The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource.

◆ MediaDownloader

Google.Apis.Download.IMediaDownloader Google.Apis.YouTube.v3.CaptionsResource.DownloadRequest.MediaDownloader
get

Gets the media downloader.

◆ MethodName

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

summary>Gets the HTTP method.

◆ OnBehalfOf

virtual string Google.Apis.YouTube.v3.CaptionsResource.DownloadRequest.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.DownloadRequest.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.

◆ Tfmt

virtual System.Nullable<TfmtEnum> Google.Apis.YouTube.v3.CaptionsResource.DownloadRequest.Tfmt
getset

The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format.

◆ Tlang

virtual string Google.Apis.YouTube.v3.CaptionsResource.DownloadRequest.Tlang
getset

The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.

summary>Gets the method name.


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