com.google.api.services.youtube

Class YouTube.LiveBroadcasts.Control

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<LiveBroadcast>

com.google.api.services.youtube.YouTube.LiveBroadcasts.Control

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.LiveBroadcasts

public class YouTube.LiveBroadcasts.Control
extends YouTubeRequest<LiveBroadcast>

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	Control(String id, List<String> part) Slate and recording control of the live broadcast.

Method Summary

Modifier and Type	Method and Description
Boolean	getDisplaySlate() Whether display or hide slate.
String	getId() Broadcast to operate.
BigInteger	getOffsetTimeMs() The exact time when the actions (e.g.
String	getOnBehalfOfContentOwner() Note:* This parameter is intended exclusively for YouTube content partners.
String	getOnBehalfOfContentOwnerChannel() This parameter can only be used in a properly authorized request.
List<String>	getPart() The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include.
String	getWalltime() The wall clock time at which the action should be executed.
YouTube.LiveBroadcasts.Control	set(String parameterName, Object value)
YouTube.LiveBroadcasts.Control	set$Xgafv(String $Xgafv) V1 error format.
YouTube.LiveBroadcasts.Control	setAccessToken(String accessToken) OAuth access token.
YouTube.LiveBroadcasts.Control	setAlt(String alt) Data format for response.
YouTube.LiveBroadcasts.Control	setCallback(String callback) JSONP
YouTube.LiveBroadcasts.Control	setDisplaySlate(Boolean displaySlate) Whether display or hide slate.
YouTube.LiveBroadcasts.Control	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.LiveBroadcasts.Control	setId(String id) Broadcast to operate.
YouTube.LiveBroadcasts.Control	setKey(String key) API key.
YouTube.LiveBroadcasts.Control	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.LiveBroadcasts.Control	setOffsetTimeMs(BigInteger offsetTimeMs) The exact time when the actions (e.g.
YouTube.LiveBroadcasts.Control	setOnBehalfOfContentOwner(String onBehalfOfContentOwner) *Note:* This parameter is intended exclusively for YouTube content partners.
YouTube.LiveBroadcasts.Control	setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel) This parameter can only be used in a properly authorized request.
YouTube.LiveBroadcasts.Control	setPart(List<String> part) The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include.
YouTube.LiveBroadcasts.Control	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.LiveBroadcasts.Control	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
YouTube.LiveBroadcasts.Control	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
YouTube.LiveBroadcasts.Control	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
YouTube.LiveBroadcasts.Control	setWalltime(String walltime) The wall clock time at which the action should be executed.

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

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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

Control

protected Control(String id,
                  List<String> part)

Slate and recording control of the live broadcast. Support actions: slate on/off, recording start/stop/pause/resume. Design doc: goto/yt-api-liveBroadcast-control Create a request for the method "liveBroadcasts.control". 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:

id - Broadcast to operate.

part - The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.

Since:

1.13

Method Detail

set$Xgafv

public YouTube.LiveBroadcasts.Control set$Xgafv(String $Xgafv)

Description copied from class: YouTubeRequest

V1 error format.

Overrides:

set$Xgafv in class YouTubeRequest<LiveBroadcast>

setAccessToken

public YouTube.LiveBroadcasts.Control setAccessToken(String accessToken)

Description copied from class: YouTubeRequest

OAuth access token.

Overrides:

setAccessToken in class YouTubeRequest<LiveBroadcast>

setAlt

public YouTube.LiveBroadcasts.Control setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for response.

Overrides:

setAlt in class YouTubeRequest<LiveBroadcast>

setCallback

public YouTube.LiveBroadcasts.Control setCallback(String callback)

Description copied from class: YouTubeRequest

JSONP

Overrides:

setCallback in class YouTubeRequest<LiveBroadcast>

setFields

public YouTube.LiveBroadcasts.Control setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<LiveBroadcast>

setKey

public YouTube.LiveBroadcasts.Control 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<LiveBroadcast>

setOauthToken

public YouTube.LiveBroadcasts.Control setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<LiveBroadcast>

setPrettyPrint

public YouTube.LiveBroadcasts.Control setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<LiveBroadcast>

setQuotaUser

public YouTube.LiveBroadcasts.Control setQuotaUser(String quotaUser)

Description copied from class: YouTubeRequest

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:

setQuotaUser in class YouTubeRequest<LiveBroadcast>

setUploadType

public YouTube.LiveBroadcasts.Control setUploadType(String uploadType)

Description copied from class: YouTubeRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class YouTubeRequest<LiveBroadcast>

setUploadProtocol

public YouTube.LiveBroadcasts.Control setUploadProtocol(String uploadProtocol)

Description copied from class: YouTubeRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class YouTubeRequest<LiveBroadcast>

getId

public String getId()

Broadcast to operate.

setId

public YouTube.LiveBroadcasts.Control setId(String id)

Broadcast to operate.

getPart

public List<String> getPart()

The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.

setPart

public YouTube.LiveBroadcasts.Control setPart(List<String> part)

The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.

getDisplaySlate

public Boolean getDisplaySlate()

Whether display or hide slate.

setDisplaySlate

public YouTube.LiveBroadcasts.Control setDisplaySlate(Boolean displaySlate)

Whether display or hide slate.

getOffsetTimeMs

public BigInteger getOffsetTimeMs()

The exact time when the actions (e.g. slate on) are executed. It is an offset from the first frame of the monitor stream. If not set, it means "now" or ASAP. This field should not be set if the monitor stream is disabled, otherwise an error will be returned.

setOffsetTimeMs

public YouTube.LiveBroadcasts.Control setOffsetTimeMs(BigInteger offsetTimeMs)

The exact time when the actions (e.g. slate on) are executed. It is an offset from the first frame of the monitor stream. If not set, it means "now" or ASAP. This field should not be set if the monitor stream is disabled, otherwise an error will be returned.

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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

setOnBehalfOfContentOwner

public YouTube.LiveBroadcasts.Control 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

getOnBehalfOfContentOwnerChannel

public String getOnBehalfOfContentOwnerChannel()

This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

setOnBehalfOfContentOwnerChannel

public YouTube.LiveBroadcasts.Control setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel)

This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

getWalltime

public String getWalltime()

The wall clock time at which the action should be executed. Only one of offset_time_ms and walltime may be set at a time.

setWalltime

public YouTube.LiveBroadcasts.Control setWalltime(String walltime)

The wall clock time at which the action should be executed. Only one of offset_time_ms and walltime may be set at a time.

set

public YouTube.LiveBroadcasts.Control set(String parameterName,
                                          Object value)

Overrides:

set in class YouTubeRequest<LiveBroadcast>