com.google.api.services.youtube.model.LiveBroadcastContentDetails Maven / Gradle / Ivy
/*
* Copyright 2010 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://code.google.com/p/google-apis-client-generator/
* (build: 2013-06-05 16:09:48 UTC)
* on 2013-06-12 at 00:00:52 UTC
* Modify at your own risk.
*/
package com.google.api.services.youtube.model;
/**
* Slate settings of a broadcast.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the YouTube Data API. For a detailed explanation see:
* http://code.google.com/p/google-http-java-client/wiki/JSON
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class LiveBroadcastContentDetails extends com.google.api.client.json.GenericJson {
/**
* This value uniquely identifies the live stream bound to the broadcast.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String boundStreamId;
/**
* This setting indicates whether YouTube should enable content encryption for the broadcast.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean enableContentEncryption;
/**
* This setting determines whether viewers can access DVR controls while watching the video. DVR
* controls enable the viewer to control the video playback experience by pausing, rewinding, or
* fast forwarding content. The default value for this property is true.
*
* Important: You must set the value to true and also set the enableArchive property's value to
* true if you want to make playback available immediately after the broadcast ends.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean enableDvr;
/**
* This setting indicates whether the broadcast video can be played in an embedded player. If you
* choose to archive the video (using the enableArchive property), this setting will also apply to
* the archived video.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean enableEmbed;
/**
* The monitorStream object contains information about the monitor stream, which the broadcaster
* can use to review the event content before the broadcast stream is shown publicly.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private MonitorStream monitorStream;
/**
* Automatically start recording after the event goes live. The default value for this property is
* true.
*
* Important: You must also set the enableDvr property's value to true if you want the playback to
* be available immediately after the broadcast ends. If you set this property's value to true but
* do not also set the enableDvr property to true, there may be a delay of around one day before
* the archived video will be available for playback.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean recordFromStart;
/**
* This setting indicates whether the broadcast should automatically begin with an in-stream slate
* when you update the broadcast's status to live. After updating the status, you then need to
* send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the
* in-stream slate and make your broadcast stream visible to viewers.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean startWithSlate;
/**
* This value uniquely identifies the live stream bound to the broadcast.
* @return value or {@code null} for none
*/
public java.lang.String getBoundStreamId() {
return boundStreamId;
}
/**
* This value uniquely identifies the live stream bound to the broadcast.
* @param boundStreamId boundStreamId or {@code null} for none
*/
public LiveBroadcastContentDetails setBoundStreamId(java.lang.String boundStreamId) {
this.boundStreamId = boundStreamId;
return this;
}
/**
* This setting indicates whether YouTube should enable content encryption for the broadcast.
* @return value or {@code null} for none
*/
public java.lang.Boolean getEnableContentEncryption() {
return enableContentEncryption;
}
/**
* This setting indicates whether YouTube should enable content encryption for the broadcast.
* @param enableContentEncryption enableContentEncryption or {@code null} for none
*/
public LiveBroadcastContentDetails setEnableContentEncryption(java.lang.Boolean enableContentEncryption) {
this.enableContentEncryption = enableContentEncryption;
return this;
}
/**
* This setting determines whether viewers can access DVR controls while watching the video. DVR
* controls enable the viewer to control the video playback experience by pausing, rewinding, or
* fast forwarding content. The default value for this property is true.
*
* Important: You must set the value to true and also set the enableArchive property's value to
* true if you want to make playback available immediately after the broadcast ends.
* @return value or {@code null} for none
*/
public java.lang.Boolean getEnableDvr() {
return enableDvr;
}
/**
* This setting determines whether viewers can access DVR controls while watching the video. DVR
* controls enable the viewer to control the video playback experience by pausing, rewinding, or
* fast forwarding content. The default value for this property is true.
*
* Important: You must set the value to true and also set the enableArchive property's value to
* true if you want to make playback available immediately after the broadcast ends.
* @param enableDvr enableDvr or {@code null} for none
*/
public LiveBroadcastContentDetails setEnableDvr(java.lang.Boolean enableDvr) {
this.enableDvr = enableDvr;
return this;
}
/**
* This setting indicates whether the broadcast video can be played in an embedded player. If you
* choose to archive the video (using the enableArchive property), this setting will also apply to
* the archived video.
* @return value or {@code null} for none
*/
public java.lang.Boolean getEnableEmbed() {
return enableEmbed;
}
/**
* This setting indicates whether the broadcast video can be played in an embedded player. If you
* choose to archive the video (using the enableArchive property), this setting will also apply to
* the archived video.
* @param enableEmbed enableEmbed or {@code null} for none
*/
public LiveBroadcastContentDetails setEnableEmbed(java.lang.Boolean enableEmbed) {
this.enableEmbed = enableEmbed;
return this;
}
/**
* The monitorStream object contains information about the monitor stream, which the broadcaster
* can use to review the event content before the broadcast stream is shown publicly.
* @return value or {@code null} for none
*/
public MonitorStream getMonitorStream() {
return monitorStream;
}
/**
* The monitorStream object contains information about the monitor stream, which the broadcaster
* can use to review the event content before the broadcast stream is shown publicly.
* @param monitorStream monitorStream or {@code null} for none
*/
public LiveBroadcastContentDetails setMonitorStream(MonitorStream monitorStream) {
this.monitorStream = monitorStream;
return this;
}
/**
* Automatically start recording after the event goes live. The default value for this property is
* true.
*
* Important: You must also set the enableDvr property's value to true if you want the playback to
* be available immediately after the broadcast ends. If you set this property's value to true but
* do not also set the enableDvr property to true, there may be a delay of around one day before
* the archived video will be available for playback.
* @return value or {@code null} for none
*/
public java.lang.Boolean getRecordFromStart() {
return recordFromStart;
}
/**
* Automatically start recording after the event goes live. The default value for this property is
* true.
*
* Important: You must also set the enableDvr property's value to true if you want the playback to
* be available immediately after the broadcast ends. If you set this property's value to true but
* do not also set the enableDvr property to true, there may be a delay of around one day before
* the archived video will be available for playback.
* @param recordFromStart recordFromStart or {@code null} for none
*/
public LiveBroadcastContentDetails setRecordFromStart(java.lang.Boolean recordFromStart) {
this.recordFromStart = recordFromStart;
return this;
}
/**
* This setting indicates whether the broadcast should automatically begin with an in-stream slate
* when you update the broadcast's status to live. After updating the status, you then need to
* send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the
* in-stream slate and make your broadcast stream visible to viewers.
* @return value or {@code null} for none
*/
public java.lang.Boolean getStartWithSlate() {
return startWithSlate;
}
/**
* This setting indicates whether the broadcast should automatically begin with an in-stream slate
* when you update the broadcast's status to live. After updating the status, you then need to
* send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the
* in-stream slate and make your broadcast stream visible to viewers.
* @param startWithSlate startWithSlate or {@code null} for none
*/
public LiveBroadcastContentDetails setStartWithSlate(java.lang.Boolean startWithSlate) {
this.startWithSlate = startWithSlate;
return this;
}
@Override
public LiveBroadcastContentDetails set(String fieldName, Object value) {
return (LiveBroadcastContentDetails) super.set(fieldName, value);
}
@Override
public LiveBroadcastContentDetails clone() {
return (LiveBroadcastContentDetails) super.clone();
}
/**
* The monitorStream object contains information about the monitor stream, which the broadcaster can
* use to review the event content before the broadcast stream is shown publicly.
*/
public static final class MonitorStream extends com.google.api.client.json.GenericJson {
/**
* If you have set the enableMonitorStream property to true, then this property determines the
* length of the live broadcast delay.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Long broadcastStreamDelayMs;
/**
* HTML code that embeds a player that plays the monitor stream.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String embedHtml;
/**
* This value determines whether the monitor stream is enabled for the broadcast. If the monitor
* stream is enabled, then YouTube will broadcast the event content on a special stream intended
* only for the broadcaster's consumption. The broadcaster can use the stream to review the event
* content and also to identify the optimal times to insert cuepoints.
*
* You need to set this value to true if you intend to have a broadcast delay for your event.
*
* Note: This property cannot be updated once the broadcast is in the testing or live state.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean enableMonitorStream;
/**
* If you have set the enableMonitorStream property to true, then this property determines the
* length of the live broadcast delay.
* @return value or {@code null} for none
*/
public java.lang.Long getBroadcastStreamDelayMs() {
return broadcastStreamDelayMs;
}
/**
* If you have set the enableMonitorStream property to true, then this property determines the
* length of the live broadcast delay.
* @param broadcastStreamDelayMs broadcastStreamDelayMs or {@code null} for none
*/
public MonitorStream setBroadcastStreamDelayMs(java.lang.Long broadcastStreamDelayMs) {
this.broadcastStreamDelayMs = broadcastStreamDelayMs;
return this;
}
/**
* HTML code that embeds a player that plays the monitor stream.
* @return value or {@code null} for none
*/
public java.lang.String getEmbedHtml() {
return embedHtml;
}
/**
* HTML code that embeds a player that plays the monitor stream.
* @param embedHtml embedHtml or {@code null} for none
*/
public MonitorStream setEmbedHtml(java.lang.String embedHtml) {
this.embedHtml = embedHtml;
return this;
}
/**
* This value determines whether the monitor stream is enabled for the broadcast. If the monitor
* stream is enabled, then YouTube will broadcast the event content on a special stream intended
* only for the broadcaster's consumption. The broadcaster can use the stream to review the event
* content and also to identify the optimal times to insert cuepoints.
*
* You need to set this value to true if you intend to have a broadcast delay for your event.
*
* Note: This property cannot be updated once the broadcast is in the testing or live state.
* @return value or {@code null} for none
*/
public java.lang.Boolean getEnableMonitorStream() {
return enableMonitorStream;
}
/**
* This value determines whether the monitor stream is enabled for the broadcast. If the monitor
* stream is enabled, then YouTube will broadcast the event content on a special stream intended
* only for the broadcaster's consumption. The broadcaster can use the stream to review the event
* content and also to identify the optimal times to insert cuepoints.
*
* You need to set this value to true if you intend to have a broadcast delay for your event.
*
* Note: This property cannot be updated once the broadcast is in the testing or live state.
* @param enableMonitorStream enableMonitorStream or {@code null} for none
*/
public MonitorStream setEnableMonitorStream(java.lang.Boolean enableMonitorStream) {
this.enableMonitorStream = enableMonitorStream;
return this;
}
@Override
public MonitorStream set(String fieldName, Object value) {
return (MonitorStream) super.set(fieldName, value);
}
@Override
public MonitorStream clone() {
return (MonitorStream) super.clone();
}
}
}