com.google.api.services.youtube

Class YouTube.Captions.Insert

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.youtube.YouTubeRequest<Caption>

com.google.api.services.youtube.YouTube.Captions.Insert

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.Captions

public class YouTube.Captions.Insert
extends YouTubeRequest<Caption>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Insert(String part, Caption content) Uploads a caption track.
protected	Insert(String part, Caption content, AbstractInputStreamContent mediaContent) Uploads a caption track.

Method Summary

Modifier and Type	Method and Description
String	getOnBehalfOf() ID of the Google+ Page for the channel that the request is be on behalf of
String	getOnBehalfOfContentOwner() Note: This parameter is intended exclusively for YouTube content partners.
String	getPart() The part parameter specifies the caption resource parts that the API response will include.
Boolean	getSync() The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video.
YouTube.Captions.Insert	set(String parameterName, Object value)
YouTube.Captions.Insert	setAlt(String alt) Data format for the response.
YouTube.Captions.Insert	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Captions.Insert	setKey(String key) API key.
YouTube.Captions.Insert	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.Captions.Insert	setOnBehalfOf(String onBehalfOf) ID of the Google+ Page for the channel that the request is be on behalf of
YouTube.Captions.Insert	setOnBehalfOfContentOwner(String onBehalfOfContentOwner) Note: This parameter is intended exclusively for YouTube content partners.
YouTube.Captions.Insert	setPart(String part) The part parameter specifies the caption resource parts that the API response will include.
YouTube.Captions.Insert	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Captions.Insert	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
YouTube.Captions.Insert	setSync(Boolean sync) The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video.
YouTube.Captions.Insert	setUserIp(String userIp) Deprecated.

Methods inherited from class com.google.api.services.youtube.YouTubeRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Insert

protected Insert(String part,
                 Caption content)

Uploads a caption track. Create a request for the method "captions.insert". This request holds the parameters needed by the the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

YouTube.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

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

content - the Caption

Since:

1.13

Insert

protected Insert(String part,
                 Caption content,
                 AbstractInputStreamContent mediaContent)

Uploads a caption track. Create a request for the method "captions.insert". This request holds the parameters needed by the the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

YouTube.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

This constructor should be used for uploading media content.

Parameters:

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

content - the Caption media metadata or null if none

mediaContent - The media HTTP content or null if none.

Since:

1.13

Method Detail

setAlt

public YouTube.Captions.Insert setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt in class YouTubeRequest<Caption>

setFields

public YouTube.Captions.Insert setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<Caption>

setKey

public YouTube.Captions.Insert setKey(String key)

Description copied from class: YouTubeRequest

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.

Overrides:

setKey in class YouTubeRequest<Caption>

setOauthToken

public YouTube.Captions.Insert setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<Caption>

setPrettyPrint

public YouTube.Captions.Insert setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<Caption>

setQuotaUser

public YouTube.Captions.Insert setQuotaUser(String quotaUser)

Description copied from class: YouTubeRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class YouTubeRequest<Caption>

setUserIp

public YouTube.Captions.Insert setUserIp(String userIp)

Description copied from class: YouTubeRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class YouTubeRequest<Caption>

getPart

public String getPart()

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

setPart

public YouTube.Captions.Insert setPart(String part)

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

getOnBehalfOf

public String getOnBehalfOf()

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

setOnBehalfOf

public YouTube.Captions.Insert setOnBehalfOf(String onBehalfOf)

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

getOnBehalfOfContentOwner

public String getOnBehalfOfContentOwner()

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.

setOnBehalfOfContentOwner

public YouTube.Captions.Insert setOnBehalfOfContentOwner(String onBehalfOfContentOwner)

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.

getSync

public Boolean getSync()

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.

setSync

public YouTube.Captions.Insert setSync(Boolean sync)

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.

set

public YouTube.Captions.Insert set(String parameterName,
                                   Object value)

Overrides:

set in class YouTubeRequest<Caption>