Network.Google.Resource.YouTube.LiveStreams.List

Returns a list of video streams that match the API request parameters.

See: YouTube Data API Reference for youtube.liveStreams.list.

REST Resource

type LiveStreamsListResource = "youtube" :> ("v3" :> ("liveStreams" :> (QueryParam "part" Text :> (QueryParam "mine" Bool :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "id" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` LiveStreamListResponse))))))))))

A resource alias for youtube.liveStreams.list method which the LiveStreamsList request conforms to.

Creating a Request

liveStreamsList

Arguments

:: Text

lslPart

-> LiveStreamsList

Creates a value of LiveStreamsList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lslPart
• lslMine
• lslOnBehalfOfContentOwner
• lslOnBehalfOfContentOwnerChannel
• lslId
• lslPageToken
• lslMaxResults

data LiveStreamsList

Returns a list of video streams that match the API request parameters.

See: liveStreamsList smart constructor.

Instances

Eq LiveStreamsList

Data LiveStreamsList

Show LiveStreamsList

Generic LiveStreamsList

GoogleRequest LiveStreamsList

type Rep LiveStreamsList

type Rs LiveStreamsList = LiveStreamListResponse

Request Lenses

lslPart :: Lens' LiveStreamsList Text

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

lslMine :: Lens' LiveStreamsList (Maybe Bool)

The mine parameter can be used to instruct the API to only return streams owned by the authenticated user. Set the parameter value to true to only retrieve your own streams.

lslOnBehalfOfContentOwner :: Lens' LiveStreamsList (Maybe Text)

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.

lslOnBehalfOfContentOwnerChannel :: Lens' LiveStreamsList (Maybe Text)

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.

lslId :: Lens' LiveStreamsList (Maybe Text)

The id parameter specifies a comma-separated list of YouTube stream IDs that identify the streams being retrieved. In a liveStream resource, the id property specifies the stream's ID.

lslPageToken :: Lens' LiveStreamsList (Maybe Text)

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.

lslMaxResults :: Lens' LiveStreamsList Word32

The maxResults parameter specifies the maximum number of items that should be returned in the result set.