com.google.api.services.youtube

Class YouTube.LiveBroadcasts.Control

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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

com.google.api.client.util.GenericData.Flags

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

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

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

java.util.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(java.lang.String id, java.lang.String part) Controls the settings for a slate that can be displayed in the broadcast stream.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getDisplaySlate() The displaySlate parameter specifies whether the slate is being enabled or disabled.
java.lang.String	getId() The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated.
java.math.BigInteger	getOffsetTimeMs() The offsetTimeMs parameter specifies a positive time offset when the specified slate change will occur.
java.lang.String	getOnBehalfOfContentOwner() Note: This parameter is intended exclusively for YouTube content partners.
java.lang.String	getOnBehalfOfContentOwnerChannel() This parameter can only be used in a properly authorized request.
java.lang.String	getPart() The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include.
com.google.api.client.util.DateTime	getWalltime() The walltime parameter specifies the wall clock time at which the specified slate change will occur.
YouTube.LiveBroadcasts.Control	set(java.lang.String parameterName, java.lang.Object value)
YouTube.LiveBroadcasts.Control	setAlt(java.lang.String alt) Data format for the response.
YouTube.LiveBroadcasts.Control	setDisplaySlate(java.lang.Boolean displaySlate) The displaySlate parameter specifies whether the slate is being enabled or disabled.
YouTube.LiveBroadcasts.Control	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
YouTube.LiveBroadcasts.Control	setId(java.lang.String id) The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated.
YouTube.LiveBroadcasts.Control	setKey(java.lang.String key) API key.
YouTube.LiveBroadcasts.Control	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
YouTube.LiveBroadcasts.Control	setOffsetTimeMs(java.math.BigInteger offsetTimeMs) The offsetTimeMs parameter specifies a positive time offset when the specified slate change will occur.
YouTube.LiveBroadcasts.Control	setOnBehalfOfContentOwner(java.lang.String onBehalfOfContentOwner) Note: This parameter is intended exclusively for YouTube content partners.
YouTube.LiveBroadcasts.Control	setOnBehalfOfContentOwnerChannel(java.lang.String onBehalfOfContentOwnerChannel) This parameter can only be used in a properly authorized request.
YouTube.LiveBroadcasts.Control	setPart(java.lang.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(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.LiveBroadcasts.Control	setQuotaUser(java.lang.String quotaUser) An opaque string that represents a user for quota purposes.
YouTube.LiveBroadcasts.Control	setUserIp(java.lang.String userIp) Deprecated.
YouTube.LiveBroadcasts.Control	setWalltime(com.google.api.client.util.DateTime walltime) The walltime parameter specifies the wall clock time at which the specified slate change will occur.

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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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(java.lang.String id,
                  java.lang.String part)

Controls the settings for a slate that can be displayed in the broadcast stream. 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 - The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated.

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

setAlt

public YouTube.LiveBroadcasts.Control setAlt(java.lang.String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt in class YouTubeRequest<LiveBroadcast>

setFields

public YouTube.LiveBroadcasts.Control setFields(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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<LiveBroadcast>

setUserIp

public YouTube.LiveBroadcasts.Control setUserIp(java.lang.String userIp)

Description copied from class: YouTubeRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class YouTubeRequest<LiveBroadcast>

getId

public java.lang.String getId()

The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated.

setId

public YouTube.LiveBroadcasts.Control setId(java.lang.String id)

The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated.

getPart

public java.lang.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(java.lang.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 java.lang.Boolean getDisplaySlate()

The displaySlate parameter specifies whether the slate is being enabled or disabled.

setDisplaySlate

public YouTube.LiveBroadcasts.Control setDisplaySlate(java.lang.Boolean displaySlate)

The displaySlate parameter specifies whether the slate is being enabled or disabled.

getOffsetTimeMs

public java.math.BigInteger getOffsetTimeMs()

The offsetTimeMs parameter specifies a positive time offset when the specified slate change will occur. The value is measured in milliseconds from the beginning of the broadcast's monitor stream, which is the time that the testing phase for the broadcast began. Even though it is specified in milliseconds, the value is actually an approximation, and YouTube completes the requested action as closely as possible to that time. If you do not specify a value for this parameter, then YouTube performs the action as soon as possible. See the Getting started guide for more details. Important: You should only specify a value for this parameter if your broadcast stream is delayed.

setOffsetTimeMs

public YouTube.LiveBroadcasts.Control setOffsetTimeMs(java.math.BigInteger offsetTimeMs)

The offsetTimeMs parameter specifies a positive time offset when the specified slate change will occur. The value is measured in milliseconds from the beginning of the broadcast's monitor stream, which is the time that the testing phase for the broadcast began. Even though it is specified in milliseconds, the value is actually an approximation, and YouTube completes the requested action as closely as possible to that time. If you do not specify a value for this parameter, then YouTube performs the action as soon as possible. See the Getting started guide for more details. Important: You should only specify a value for this parameter if your broadcast stream is delayed.

getOnBehalfOfContentOwner

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 com.google.api.client.util.DateTime getWalltime()

The walltime parameter specifies the wall clock time at which the specified slate change will occur. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.

setWalltime

public YouTube.LiveBroadcasts.Control setWalltime(com.google.api.client.util.DateTime walltime)

The walltime parameter specifies the wall clock time at which the specified slate change will occur. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.

set

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

Overrides:

set in class YouTubeRequest<LiveBroadcast>