transition method

Future<LiveBroadcast> transition(String broadcastStatus, String id, List<String> part, { String? onBehalfOfContentOwner, String? onBehalfOfContentOwnerChannel, String? $fields, })

Transition a broadcast to a given status.

Request parameters:

broadcastStatus - The status to which the broadcast is going to transition. Possible string values are:

• "statusUnspecified"
• "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.",
• "live" : Return only persistent broadcasts.
• "complete" : The broadcast is over. YouTube stops transmitting video.

id - Broadcast to transition.

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

onBehalfOfContentOwner - Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

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

$fields - Selector specifying which fields to include in a partial response.

Completes with a LiveBroadcast.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<LiveBroadcast> transition(
  core.String broadcastStatus,
  core.String id,
  core.List<core.String> part, {
  core.String? onBehalfOfContentOwner,
  core.String? onBehalfOfContentOwnerChannel,
  core.String? $fields,
}) async {
  if (part.isEmpty) {
    throw core.ArgumentError('Parameter part cannot be empty.');
  }
  final queryParams_ = <core.String, core.List<core.String>>{
    'broadcastStatus': [broadcastStatus],
    'id': [id],
    'part': part,
    if (onBehalfOfContentOwner != null)
      'onBehalfOfContentOwner': [onBehalfOfContentOwner],
    if (onBehalfOfContentOwnerChannel != null)
      'onBehalfOfContentOwnerChannel': [onBehalfOfContentOwnerChannel],
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'youtube/v3/liveBroadcasts/transition';

  final response_ = await _requester.request(
    url_,
    'POST',
    queryParams: queryParams_,
  );
  return LiveBroadcast.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}