Blame - docs/dyn/youtube_v3.liveBroadcasts.html - platform/external/python/google-api-python-client

blob: 143e8a0a1ad269e962ec68eabcc9eccaba52c41a [file] [log] [blame]

Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.liveBroadcasts.html">liveBroadcasts</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	78	<code><a href="#bind">bind(id, part, onBehalfOfContentOwner=None, streamId=None)</a></code></p>
				79	<p class="firstline">Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream.</p>
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	80	<p class="toc_element">
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	81	<code><a href="#control">control(id, part, onBehalfOfContentOwner=None, displaySlate=None, offsetTimeMs=None)</a></code></p>
				82	<p class="firstline">Control the slate of the broadacast.</p>
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	83	<p class="toc_element">
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	84	<code><a href="#delete">delete(id, onBehalfOfContentOwner=None)</a></code></p>
				85	<p class="firstline">Deletes a broadcast.</p>
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	86	<p class="toc_element">
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	87	<code><a href="#insert">insert(part=None, body, onBehalfOfContentOwner=None)</a></code></p>
				88	<p class="firstline">Creates a broadcast.</p>
				89	<p class="toc_element">
				90	<code><a href="#list">list(part, broadcastStatus=None, pageToken=None, mine=None, maxResults=None, id=None)</a></code></p>
				91	<p class="firstline">Returns a list of YouTube broadcasts that match the API request parameters.</p>
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	96	<code><a href="#transition">transition(broadcastStatus, id, part, onBehalfOfContentOwner=None)</a></code></p>
				97	<p class="firstline">Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream.</p>
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	98	<p class="toc_element">
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	99	<code><a href="#update">update(part=None, body, onBehalfOfContentOwner=None)</a></code></p>
				100	<p class="firstline">Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.</p>
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	101	<h3>Method Details</h3>
				102	<div class="method">
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	103	<code class="details" id="bind">bind(id, part, onBehalfOfContentOwner=None, streamId=None)</code>
				104	<pre>Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	105
				106	Args:
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	107	id: string, The id parameter specifies the unique ID of the broadcast that is being bound to a video stream. (required)
				108	part: string, 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. (required)
				109	onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
				110	streamId: string, The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast. If this parameter is omitted, the API will remove any existing binding between the broadcast and a video stream.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	111
				112	Returns:
				113	An object of the form:
				114
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	115	{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
				116	"status": { # The status object contains information about the event's status.
				117	"recordingStatus": "A String", # The broadcast's recording status.
				118	"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
				119	"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	120	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	121	"kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
				122	"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
				123	"startWithSlate": True or False, # 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.
				124	"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
				125	"enableEmbed": True or False, # 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.
				126	"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
				127	"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
				128	"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
				129	#
				130	#
				131	#
				132	# 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.
				133	"enableDvr": True or False, # 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.
				134	#
				135	#
				136	#
				137	# 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.
				138	"monitorStream": { # Settings and Info of the monitor stream # 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.
				139	"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
				140	"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
				141	"enableMonitorStream": True or False, # 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.
				142	#
				143	# You need to set this value to true if you intend to have a broadcast delay for your event.
				144	#
				145	# Note: This property cannot be updated once the broadcast is in the testing or live state.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	146	},
				147	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	148	"snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
				149	"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				150	"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
				151	"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
				152	"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
				153	"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				154	"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				155	"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				156	"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				157	"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
				158	"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
				159	"url": "A String", # The thumbnail image's URL.
				160	"width": 42, # (Optional) Width of the thumbnail image.
				161	"height": 42, # (Optional) Height of the thumbnail image.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	162	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	163	"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
				164	"url": "A String", # The thumbnail image's URL.
				165	"width": 42, # (Optional) Width of the thumbnail image.
				166	"height": 42, # (Optional) Height of the thumbnail image.
				167	},
				168	"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
				169	"url": "A String", # The thumbnail image's URL.
				170	"width": 42, # (Optional) Width of the thumbnail image.
				171	"height": 42, # (Optional) Height of the thumbnail image.
				172	},
				173	"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
				174	"url": "A String", # The thumbnail image's URL.
				175	"width": 42, # (Optional) Width of the thumbnail image.
				176	"height": 42, # (Optional) Height of the thumbnail image.
				177	},
				178	"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	179	"url": "A String", # The thumbnail image's URL.
				180	"width": 42, # (Optional) Width of the thumbnail image.
				181	"height": 42, # (Optional) Height of the thumbnail image.
				182	},
				183	},
				184	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	185	"etag": "A String", # Etag of this resource.
				186	"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
				187	}</pre>
				188	</div>
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	189
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	190	<div class="method">
				191	<code class="details" id="control">control(id, part, onBehalfOfContentOwner=None, displaySlate=None, offsetTimeMs=None)</code>
				192	<pre>Control the slate of the broadacast.
				193
				194	Args:
				195	id: string, The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted. (required)
				196	part: string, 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. (required)
				197	onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
				198	displaySlate: boolean, The displaySlate parameter specifies whether to enable or disable the slate.
				199	offsetTimeMs: string, The offsetTimeMs parameter specifies a point in time in the video when the specified action (e.g. display a slate) is executed. The property value identifies a positive time offset, in milliseconds, from the beginning of the monitor stream. Though measured in milliseconds, the value is actually an approximation, and YouTube will act as closely as possible to that time. If not specified, it indicates that the action should be performed as soon as possible. If your broadcast stream is not delayed, then it should not be specified. However, if your broadcast stream is delayed, then the parameter can specify the time when the operation should be executed. See the Getting started guide for more details. Note: The offset is measured from the time that the testing phase began.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	200
				201	Returns:
				202	An object of the form:
				203
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	204	{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
				205	"status": { # The status object contains information about the event's status.
				206	"recordingStatus": "A String", # The broadcast's recording status.
				207	"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
				208	"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
				209	},
				210	"kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
				211	"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
				212	"startWithSlate": True or False, # 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.
				213	"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
				214	"enableEmbed": True or False, # 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.
				215	"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
				216	"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
				217	"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
				218	#
				219	#
				220	#
				221	# 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.
				222	"enableDvr": True or False, # 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.
				223	#
				224	#
				225	#
				226	# 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.
				227	"monitorStream": { # Settings and Info of the monitor stream # 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.
				228	"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
				229	"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
				230	"enableMonitorStream": True or False, # 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.
				231	#
				232	# You need to set this value to true if you intend to have a broadcast delay for your event.
				233	#
				234	# Note: This property cannot be updated once the broadcast is in the testing or live state.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	235	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	236	},
				237	"snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
				238	"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				239	"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
				240	"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
				241	"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
				242	"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				243	"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				244	"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				245	"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				246	"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
				247	"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
				248	"url": "A String", # The thumbnail image's URL.
				249	"width": 42, # (Optional) Width of the thumbnail image.
				250	"height": 42, # (Optional) Height of the thumbnail image.
				251	},
				252	"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
				253	"url": "A String", # The thumbnail image's URL.
				254	"width": 42, # (Optional) Width of the thumbnail image.
				255	"height": 42, # (Optional) Height of the thumbnail image.
				256	},
				257	"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
				258	"url": "A String", # The thumbnail image's URL.
				259	"width": 42, # (Optional) Width of the thumbnail image.
				260	"height": 42, # (Optional) Height of the thumbnail image.
				261	},
				262	"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
				263	"url": "A String", # The thumbnail image's URL.
				264	"width": 42, # (Optional) Width of the thumbnail image.
				265	"height": 42, # (Optional) Height of the thumbnail image.
				266	},
				267	"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
				268	"url": "A String", # The thumbnail image's URL.
				269	"width": 42, # (Optional) Width of the thumbnail image.
				270	"height": 42, # (Optional) Height of the thumbnail image.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	271	},
				272	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	273	},
				274	"etag": "A String", # Etag of this resource.
				275	"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
				276	}</pre>
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	277	</div>
				278
				279	<div class="method">
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	280	<code class="details" id="delete">delete(id, onBehalfOfContentOwner=None)</code>
				281	<pre>Deletes a broadcast.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	282
				283	Args:
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	284	id: string, The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted. (required)
				285	onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
				286	</pre>
				287	</div>
				288
				289	<div class="method">
				290	<code class="details" id="insert">insert(part=None, body, onBehalfOfContentOwner=None)</code>
				291	<pre>Creates a broadcast.
				292
				293	Args:
				294	part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
				295
				296	The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. (required)
				297	body: object, The request body. (required)
				298	The object takes the form of:
				299
				300	{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
				301	"status": { # The status object contains information about the event's status.
				302	"recordingStatus": "A String", # The broadcast's recording status.
				303	"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
				304	"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
				305	},
				306	"kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
				307	"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
				308	"startWithSlate": True or False, # 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.
				309	"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
				310	"enableEmbed": True or False, # 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.
				311	"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
				312	"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
				313	"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
				314	#
				315	#
				316	#
				317	# 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.
				318	"enableDvr": True or False, # 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.
				319	#
				320	#
				321	#
				322	# 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.
				323	"monitorStream": { # Settings and Info of the monitor stream # 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.
				324	"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
				325	"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
				326	"enableMonitorStream": True or False, # 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.
				327	#
				328	# You need to set this value to true if you intend to have a broadcast delay for your event.
				329	#
				330	# Note: This property cannot be updated once the broadcast is in the testing or live state.
				331	},
				332	},
				333	"snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
				334	"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				335	"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
				336	"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
				337	"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
				338	"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				339	"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				340	"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				341	"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				342	"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
				343	"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
				344	"url": "A String", # The thumbnail image's URL.
				345	"width": 42, # (Optional) Width of the thumbnail image.
				346	"height": 42, # (Optional) Height of the thumbnail image.
				347	},
				348	"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
				349	"url": "A String", # The thumbnail image's URL.
				350	"width": 42, # (Optional) Width of the thumbnail image.
				351	"height": 42, # (Optional) Height of the thumbnail image.
				352	},
				353	"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
				354	"url": "A String", # The thumbnail image's URL.
				355	"width": 42, # (Optional) Width of the thumbnail image.
				356	"height": 42, # (Optional) Height of the thumbnail image.
				357	},
				358	"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
				359	"url": "A String", # The thumbnail image's URL.
				360	"width": 42, # (Optional) Width of the thumbnail image.
				361	"height": 42, # (Optional) Height of the thumbnail image.
				362	},
				363	"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
				364	"url": "A String", # The thumbnail image's URL.
				365	"width": 42, # (Optional) Width of the thumbnail image.
				366	"height": 42, # (Optional) Height of the thumbnail image.
				367	},
				368	},
				369	},
				370	"etag": "A String", # Etag of this resource.
				371	"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
				372	}
				373
				374	onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
				375
				376	Returns:
				377	An object of the form:
				378
				379	{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
				380	"status": { # The status object contains information about the event's status.
				381	"recordingStatus": "A String", # The broadcast's recording status.
				382	"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
				383	"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
				384	},
				385	"kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
				386	"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
				387	"startWithSlate": True or False, # 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.
				388	"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
				389	"enableEmbed": True or False, # 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.
				390	"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
				391	"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
				392	"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
				393	#
				394	#
				395	#
				396	# 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.
				397	"enableDvr": True or False, # 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.
				398	#
				399	#
				400	#
				401	# 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.
				402	"monitorStream": { # Settings and Info of the monitor stream # 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.
				403	"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
				404	"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
				405	"enableMonitorStream": True or False, # 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.
				406	#
				407	# You need to set this value to true if you intend to have a broadcast delay for your event.
				408	#
				409	# Note: This property cannot be updated once the broadcast is in the testing or live state.
				410	},
				411	},
				412	"snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
				413	"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				414	"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
				415	"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
				416	"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
				417	"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				418	"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				419	"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				420	"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				421	"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
				422	"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
				423	"url": "A String", # The thumbnail image's URL.
				424	"width": 42, # (Optional) Width of the thumbnail image.
				425	"height": 42, # (Optional) Height of the thumbnail image.
				426	},
				427	"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
				428	"url": "A String", # The thumbnail image's URL.
				429	"width": 42, # (Optional) Width of the thumbnail image.
				430	"height": 42, # (Optional) Height of the thumbnail image.
				431	},
				432	"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
				433	"url": "A String", # The thumbnail image's URL.
				434	"width": 42, # (Optional) Width of the thumbnail image.
				435	"height": 42, # (Optional) Height of the thumbnail image.
				436	},
				437	"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
				438	"url": "A String", # The thumbnail image's URL.
				439	"width": 42, # (Optional) Width of the thumbnail image.
				440	"height": 42, # (Optional) Height of the thumbnail image.
				441	},
				442	"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
				443	"url": "A String", # The thumbnail image's URL.
				444	"width": 42, # (Optional) Width of the thumbnail image.
				445	"height": 42, # (Optional) Height of the thumbnail image.
				446	},
				447	},
				448	},
				449	"etag": "A String", # Etag of this resource.
				450	"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
				451	}</pre>
				452	</div>
				453
				454	<div class="method">
				455	<code class="details" id="list">list(part, broadcastStatus=None, pageToken=None, mine=None, maxResults=None, id=None)</code>
				456	<pre>Returns a list of YouTube broadcasts that match the API request parameters.
				457
				458	Args:
				459	part: string, 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. (required)
				460	broadcastStatus: string, The broadcastStatus parameter filters the API response to only include broadcasts with the specified status.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	461	Allowed values
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	462	active - Return current live broadcasts.
				463	all - Return all broadcasts.
				464	completed - Return broadcasts that have already ended.
				465	upcoming - Return broadcasts that have not yet started.
				466	pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
				467	mine: boolean, The mine parameter can be used to instruct the API to only return broadcasts owned by the authenticated user. Set the parameter value to true to only retrieve your own broadcasts.
				468	maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are 0 to 50, inclusive. The default value is 5.
				469	id: string, The id parameter specifies a comma-separated list of YouTube broadcast IDs that identify the broadcasts being retrieved. In a liveBroadcast resource, the id property specifies the broadcast's ID.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	470
				471	Returns:
				472	An object of the form:
				473
				474	{ # JSON template for list of broadcasts.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	475	"eventId": "A String", # Serialized EventId of the request which produced this response.
				476	"nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
				477	"kind": "youtube#liveBroadcastList", # The type of the API response. For this operation, the value will be youtube#liveBroadcastList.
				478	"visitorId": "A String", # The visitorId identifies the visitor.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	479	"items": [ # A list of broadcasts that match the request criteria.
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	480	{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
				481	"status": { # The status object contains information about the event's status.
				482	"recordingStatus": "A String", # The broadcast's recording status.
				483	"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
				484	"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	485	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	486	"kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
				487	"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
				488	"startWithSlate": True or False, # 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.
				489	"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
				490	"enableEmbed": True or False, # 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.
				491	"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
				492	"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
				493	"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
				494	#
				495	#
				496	#
				497	# 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.
				498	"enableDvr": True or False, # 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.
				499	#
				500	#
				501	#
				502	# 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.
				503	"monitorStream": { # Settings and Info of the monitor stream # 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.
				504	"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
				505	"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
				506	"enableMonitorStream": True or False, # 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.
				507	#
				508	# You need to set this value to true if you intend to have a broadcast delay for your event.
				509	#
				510	# Note: This property cannot be updated once the broadcast is in the testing or live state.
				511	},
				512	},
				513	"snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
				514	"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				515	"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
				516	"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
				517	"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
				518	"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				519	"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				520	"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				521	"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				522	"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
				523	"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
				524	"url": "A String", # The thumbnail image's URL.
				525	"width": 42, # (Optional) Width of the thumbnail image.
				526	"height": 42, # (Optional) Height of the thumbnail image.
				527	},
				528	"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
				529	"url": "A String", # The thumbnail image's URL.
				530	"width": 42, # (Optional) Width of the thumbnail image.
				531	"height": 42, # (Optional) Height of the thumbnail image.
				532	},
				533	"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
				534	"url": "A String", # The thumbnail image's URL.
				535	"width": 42, # (Optional) Width of the thumbnail image.
				536	"height": 42, # (Optional) Height of the thumbnail image.
				537	},
				538	"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
				539	"url": "A String", # The thumbnail image's URL.
				540	"width": 42, # (Optional) Width of the thumbnail image.
				541	"height": 42, # (Optional) Height of the thumbnail image.
				542	},
				543	"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
				544	"url": "A String", # The thumbnail image's URL.
				545	"width": 42, # (Optional) Width of the thumbnail image.
				546	"height": 42, # (Optional) Height of the thumbnail image.
				547	},
				548	},
				549	},
				550	"etag": "A String", # Etag of this resource.
				551	"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
				552	},
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	553	],
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	554	"etag": "A String", # The ETag of the response.
				555	"prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
				556	"pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The pageInfo object encapsulates paging information for the result set.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	557	"totalResults": 42, # The total number of results in the result set.
				558	"resultsPerPage": 42, # The number of results included in the API response.
				559	},
				560	}</pre>
				561	</div>
				562
				563	<div class="method">
				564	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				565	<pre>Retrieves the next page of results.
				566
				567	Args:
				568	previous_request: The request for the previous page. (required)
				569	previous_response: The response from the request for the previous page. (required)
				570
				571	Returns:
				572	A request object that you can call 'execute()' on to request the next
				573	page. Returns None if there are no more items in the collection.
				574	</pre>
				575	</div>
				576
				577	<div class="method">
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	578	<code class="details" id="transition">transition(broadcastStatus, id, part, onBehalfOfContentOwner=None)</code>
				579	<pre>Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	580
				581	Args:
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	582	broadcastStatus: string, The broadcastStatus parameter identifies the state to which the broadcast is changing. (required)
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	583	Allowed values
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	584	complete - The broadcast is over. YouTube stops transmitting video.
				585	live - The broadcast is visible to its audience. YouTube transmits video to the broadcast's monitor stream and its broadcast stream.
				586	testing - Start testing the broadcast. YouTube transmits video to the broadcast's monitor stream. Note that you can only transition a broadcast to the testing state if its contentDetails.monitorStream.enableMonitorStream property is set to true.
				587	id: string, The id parameter specifies the unique ID of the broadcast that is transitioning to another status. (required)
				588	part: string, 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. (required)
				589	onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	590
				591	Returns:
				592	An object of the form:
				593
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	594	{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
				595	"status": { # The status object contains information about the event's status.
				596	"recordingStatus": "A String", # The broadcast's recording status.
				597	"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
				598	"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	599	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	600	"kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
				601	"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
				602	"startWithSlate": True or False, # 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.
				603	"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
				604	"enableEmbed": True or False, # 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.
				605	"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
				606	"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
				607	"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
				608	#
				609	#
				610	#
				611	# 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.
				612	"enableDvr": True or False, # 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.
				613	#
				614	#
				615	#
				616	# 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.
				617	"monitorStream": { # Settings and Info of the monitor stream # 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.
				618	"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
				619	"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
				620	"enableMonitorStream": True or False, # 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.
				621	#
				622	# You need to set this value to true if you intend to have a broadcast delay for your event.
				623	#
				624	# Note: This property cannot be updated once the broadcast is in the testing or live state.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	625	},
				626	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	627	"snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
				628	"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				629	"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
				630	"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
				631	"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
				632	"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				633	"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				634	"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				635	"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				636	"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
				637	"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
				638	"url": "A String", # The thumbnail image's URL.
				639	"width": 42, # (Optional) Width of the thumbnail image.
				640	"height": 42, # (Optional) Height of the thumbnail image.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	641	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	642	"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
				643	"url": "A String", # The thumbnail image's URL.
				644	"width": 42, # (Optional) Width of the thumbnail image.
				645	"height": 42, # (Optional) Height of the thumbnail image.
				646	},
				647	"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
				648	"url": "A String", # The thumbnail image's URL.
				649	"width": 42, # (Optional) Width of the thumbnail image.
				650	"height": 42, # (Optional) Height of the thumbnail image.
				651	},
				652	"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
				653	"url": "A String", # The thumbnail image's URL.
				654	"width": 42, # (Optional) Width of the thumbnail image.
				655	"height": 42, # (Optional) Height of the thumbnail image.
				656	},
				657	"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	658	"url": "A String", # The thumbnail image's URL.
				659	"width": 42, # (Optional) Width of the thumbnail image.
				660	"height": 42, # (Optional) Height of the thumbnail image.
				661	},
				662	},
				663	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	664	"etag": "A String", # Etag of this resource.
				665	"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
				666	}</pre>
				667	</div>
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	668
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	669	<div class="method">
				670	<code class="details" id="update">update(part=None, body, onBehalfOfContentOwner=None)</code>
				671	<pre>Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.
				672
				673	Args:
				674	part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
				675
				676	The part properties that you can include in the parameter value are id, snippet, contentDetails, and status.
				677
				678	Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a broadcast's privacy status is defined in the status part. As such, if your request is updating a private or unlisted broadcast, and the request's part parameter value includes the status part, the broadcast's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the broadcast will revert to the default privacy setting. (required)
				679	body: object, The request body. (required)
				680	The object takes the form of:
				681
				682	{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
				683	"status": { # The status object contains information about the event's status.
				684	"recordingStatus": "A String", # The broadcast's recording status.
				685	"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
				686	"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
				687	},
				688	"kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
				689	"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
				690	"startWithSlate": True or False, # 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.
				691	"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
				692	"enableEmbed": True or False, # 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.
				693	"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
				694	"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
				695	"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
				696	#
				697	#
				698	#
				699	# 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.
				700	"enableDvr": True or False, # 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.
				701	#
				702	#
				703	#
				704	# 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.
				705	"monitorStream": { # Settings and Info of the monitor stream # 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.
				706	"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
				707	"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
				708	"enableMonitorStream": True or False, # 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.
				709	#
				710	# You need to set this value to true if you intend to have a broadcast delay for your event.
				711	#
				712	# Note: This property cannot be updated once the broadcast is in the testing or live state.
				713	},
				714	},
				715	"snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
				716	"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				717	"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
				718	"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
				719	"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
				720	"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				721	"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				722	"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				723	"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				724	"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
				725	"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
				726	"url": "A String", # The thumbnail image's URL.
				727	"width": 42, # (Optional) Width of the thumbnail image.
				728	"height": 42, # (Optional) Height of the thumbnail image.
				729	},
				730	"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
				731	"url": "A String", # The thumbnail image's URL.
				732	"width": 42, # (Optional) Width of the thumbnail image.
				733	"height": 42, # (Optional) Height of the thumbnail image.
				734	},
				735	"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
				736	"url": "A String", # The thumbnail image's URL.
				737	"width": 42, # (Optional) Width of the thumbnail image.
				738	"height": 42, # (Optional) Height of the thumbnail image.
				739	},
				740	"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
				741	"url": "A String", # The thumbnail image's URL.
				742	"width": 42, # (Optional) Width of the thumbnail image.
				743	"height": 42, # (Optional) Height of the thumbnail image.
				744	},
				745	"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
				746	"url": "A String", # The thumbnail image's URL.
				747	"width": 42, # (Optional) Width of the thumbnail image.
				748	"height": 42, # (Optional) Height of the thumbnail image.
				749	},
				750	},
				751	},
				752	"etag": "A String", # Etag of this resource.
				753	"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
				754	}
				755
				756	onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	757
				758	Returns:
				759	An object of the form:
				760
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	761	{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
				762	"status": { # The status object contains information about the event's status.
				763	"recordingStatus": "A String", # The broadcast's recording status.
				764	"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
				765	"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
				766	},
				767	"kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
				768	"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
				769	"startWithSlate": True or False, # 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.
				770	"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
				771	"enableEmbed": True or False, # 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.
				772	"enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
				773	"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
				774	"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
				775	#
				776	#
				777	#
				778	# 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.
				779	"enableDvr": True or False, # 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.
				780	#
				781	#
				782	#
				783	# 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.
				784	"monitorStream": { # Settings and Info of the monitor stream # 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.
				785	"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
				786	"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
				787	"enableMonitorStream": True or False, # 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.
				788	#
				789	# You need to set this value to true if you intend to have a broadcast delay for your event.
				790	#
				791	# Note: This property cannot be updated once the broadcast is in the testing or live state.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	792	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	793	},
				794	"snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
				795	"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				796	"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
				797	"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
				798	"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
				799	"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				800	"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				801	"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				802	"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
				803	"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
				804	"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
				805	"url": "A String", # The thumbnail image's URL.
				806	"width": 42, # (Optional) Width of the thumbnail image.
				807	"height": 42, # (Optional) Height of the thumbnail image.
				808	},
				809	"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
				810	"url": "A String", # The thumbnail image's URL.
				811	"width": 42, # (Optional) Width of the thumbnail image.
				812	"height": 42, # (Optional) Height of the thumbnail image.
				813	},
				814	"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
				815	"url": "A String", # The thumbnail image's URL.
				816	"width": 42, # (Optional) Width of the thumbnail image.
				817	"height": 42, # (Optional) Height of the thumbnail image.
				818	},
				819	"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
				820	"url": "A String", # The thumbnail image's URL.
				821	"width": 42, # (Optional) Width of the thumbnail image.
				822	"height": 42, # (Optional) Height of the thumbnail image.
				823	},
				824	"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
				825	"url": "A String", # The thumbnail image's URL.
				826	"width": 42, # (Optional) Width of the thumbnail image.
				827	"height": 42, # (Optional) Height of the thumbnail image.
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	828	},
				829	},
Joe Gregorio	37802c3	2013-08-06 12:24:05 -0400	[diff] [blame]	830	},
				831	"etag": "A String", # Etag of this resource.
				832	"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
				833	}</pre>
Joe Gregorio	b8006ce	2013-03-07 10:33:19 -0500	[diff] [blame]	834	</div>
				835
				836	</body></html>