google_youtube_api_v3/youtube/api/live

Types

Bind a broadcast to a stream.

pub type LiveBroadcastsBindParams {
  LiveBroadcastsBindParams(
    id: String,
    part: List(String),
    on_behalf_of_content_owner: option.Option(String),
    on_behalf_of_content_owner_channel: option.Option(String),
    stream_id: option.Option(String),
  )
}

Constructors

  • LiveBroadcastsBindParams(
      id: String,
      part: List(String),
      on_behalf_of_content_owner: option.Option(String),
      on_behalf_of_content_owner_channel: option.Option(String),
      stream_id: option.Option(String),
    )

Delete a given broadcast.

pub type LiveBroadcastsDeleteParams {
  LiveBroadcastsDeleteParams(
    id: String,
    on_behalf_of_content_owner: option.Option(String),
    on_behalf_of_content_owner_channel: option.Option(String),
  )
}

Constructors

  • LiveBroadcastsDeleteParams(
      id: String,
      on_behalf_of_content_owner: option.Option(String),
      on_behalf_of_content_owner_channel: option.Option(String),
    )

Insert cuepoints in a broadcast

pub type LiveBroadcastsInsertCuepointParams {
  LiveBroadcastsInsertCuepointParams(
    id: option.Option(String),
    on_behalf_of_content_owner: option.Option(String),
    on_behalf_of_content_owner_channel: option.Option(String),
    part: option.Option(List(String)),
  )
}

Constructors

Inserts a new stream for the authenticated user.

pub type LiveBroadcastsInsertParams {
  LiveBroadcastsInsertParams(
    part: List(String),
    on_behalf_of_content_owner: option.Option(String),
    on_behalf_of_content_owner_channel: option.Option(String),
  )
}

Constructors

  • LiveBroadcastsInsertParams(
      part: List(String),
      on_behalf_of_content_owner: option.Option(String),
      on_behalf_of_content_owner_channel: option.Option(String),
    )

Return broadcasts with a certain status, e.g. active broadcasts.

pub type LiveBroadcastsListBroadcastStatus {
  LiveBroadcastsListBroadcastStatusBroadcastStatusFilterUnspecified
  LiveBroadcastsListBroadcastStatusAll
  LiveBroadcastsListBroadcastStatusActive
  LiveBroadcastsListBroadcastStatusUpcoming
  LiveBroadcastsListBroadcastStatusCompleted
}

Constructors

  • LiveBroadcastsListBroadcastStatusBroadcastStatusFilterUnspecified
  • LiveBroadcastsListBroadcastStatusAll
  • LiveBroadcastsListBroadcastStatusActive
  • LiveBroadcastsListBroadcastStatusUpcoming
  • LiveBroadcastsListBroadcastStatusCompleted

Return only broadcasts with the selected type.

pub type LiveBroadcastsListBroadcastType {
  LiveBroadcastsListBroadcastTypeBroadcastTypeFilterUnspecified
  LiveBroadcastsListBroadcastTypeAll
  LiveBroadcastsListBroadcastTypeEvent
  LiveBroadcastsListBroadcastTypePersistent
}

Constructors

  • LiveBroadcastsListBroadcastTypeBroadcastTypeFilterUnspecified
  • LiveBroadcastsListBroadcastTypeAll
  • LiveBroadcastsListBroadcastTypeEvent
  • LiveBroadcastsListBroadcastTypePersistent

Retrieve the list of broadcasts associated with the given channel.

pub type LiveBroadcastsListParams {
  LiveBroadcastsListParams(
    part: List(String),
    broadcast_status: option.Option(
      LiveBroadcastsListBroadcastStatus,
    ),
    broadcast_type: option.Option(LiveBroadcastsListBroadcastType),
    id: option.Option(List(String)),
    max_results: option.Option(Int),
    mine: option.Option(Bool),
    on_behalf_of_content_owner: option.Option(String),
    on_behalf_of_content_owner_channel: option.Option(String),
    page_token: option.Option(String),
  )
}

Constructors

The status to which the broadcast is going to transition.

pub type LiveBroadcastsTransitionBroadcastStatus {
  LiveBroadcastsTransitionBroadcastStatusStatusUnspecified
  LiveBroadcastsTransitionBroadcastStatusTesting
  LiveBroadcastsTransitionBroadcastStatusLive
  LiveBroadcastsTransitionBroadcastStatusComplete
}

Constructors

  • LiveBroadcastsTransitionBroadcastStatusStatusUnspecified
  • LiveBroadcastsTransitionBroadcastStatusTesting
  • LiveBroadcastsTransitionBroadcastStatusLive
  • LiveBroadcastsTransitionBroadcastStatusComplete

Transition a broadcast to a given status.

pub type LiveBroadcastsTransitionParams {
  LiveBroadcastsTransitionParams(
    broadcast_status: LiveBroadcastsTransitionBroadcastStatus,
    id: String,
    part: List(String),
    on_behalf_of_content_owner: option.Option(String),
    on_behalf_of_content_owner_channel: option.Option(String),
  )
}

Constructors

Updates an existing broadcast for the authenticated user.

pub type LiveBroadcastsUpdateParams {
  LiveBroadcastsUpdateParams(
    part: List(String),
    on_behalf_of_content_owner: option.Option(String),
    on_behalf_of_content_owner_channel: option.Option(String),
  )
}

Constructors

  • LiveBroadcastsUpdateParams(
      part: List(String),
      on_behalf_of_content_owner: option.Option(String),
      on_behalf_of_content_owner_channel: option.Option(String),
    )

Deletes a chat ban.

pub type LiveChatBansDeleteParams {
  LiveChatBansDeleteParams(id: String)
}

Constructors

  • LiveChatBansDeleteParams(id: String)

Inserts a new resource into this collection.

pub type LiveChatBansInsertParams {
  LiveChatBansInsertParams(part: List(String))
}

Constructors

  • LiveChatBansInsertParams(part: List(String))

Deletes a chat message. A call to this method has a quota cost of 20 units.

pub type LiveChatMessagesDeleteParams {
  LiveChatMessagesDeleteParams(id: String)
}

Constructors

  • LiveChatMessagesDeleteParams(id: String)

Inserts a new resource into this collection. A call to this method has a quota cost of 20 units.

pub type LiveChatMessagesInsertParams {
  LiveChatMessagesInsertParams(part: List(String))
}

Constructors

  • LiveChatMessagesInsertParams(part: List(String))

Retrieves a list of resources, possibly filtered. A call to this method has a quota cost of 5 units.

pub type LiveChatMessagesListParams {
  LiveChatMessagesListParams(
    live_chat_id: String,
    part: List(String),
    hl: option.Option(String),
    max_results: option.Option(Int),
    page_token: option.Option(String),
    profile_image_size: option.Option(Int),
  )
}

Constructors

Transitions a durable chat event. A call to this method has a quota cost of 20 units.

pub type LiveChatMessagesTransitionParams {
  LiveChatMessagesTransitionParams(
    id: option.Option(String),
    status: option.Option(LiveChatMessagesTransitionStatus),
  )
}

Constructors

The status to which the chat event is going to transition.

pub type LiveChatMessagesTransitionStatus {
  LiveChatMessagesTransitionStatusStatusUnspecified
  LiveChatMessagesTransitionStatusClosed
}

Constructors

  • LiveChatMessagesTransitionStatusStatusUnspecified
  • LiveChatMessagesTransitionStatusClosed

Deletes a chat moderator.

pub type LiveChatModeratorsDeleteParams {
  LiveChatModeratorsDeleteParams(id: String)
}

Constructors

  • LiveChatModeratorsDeleteParams(id: String)

Inserts a new resource into this collection.

pub type LiveChatModeratorsInsertParams {
  LiveChatModeratorsInsertParams(part: List(String))
}

Constructors

  • LiveChatModeratorsInsertParams(part: List(String))

Retrieves a list of resources, possibly filtered.

pub type LiveChatModeratorsListParams {
  LiveChatModeratorsListParams(
    live_chat_id: String,
    part: List(String),
    max_results: option.Option(Int),
    page_token: option.Option(String),
  )
}

Constructors

  • LiveChatModeratorsListParams(
      live_chat_id: String,
      part: List(String),
      max_results: option.Option(Int),
      page_token: option.Option(String),
    )

Deletes an existing stream for the authenticated user.

pub type LiveStreamsDeleteParams {
  LiveStreamsDeleteParams(
    id: String,
    on_behalf_of_content_owner: option.Option(String),
    on_behalf_of_content_owner_channel: option.Option(String),
  )
}

Constructors

  • LiveStreamsDeleteParams(
      id: String,
      on_behalf_of_content_owner: option.Option(String),
      on_behalf_of_content_owner_channel: option.Option(String),
    )

Inserts a new stream for the authenticated user.

pub type LiveStreamsInsertParams {
  LiveStreamsInsertParams(
    part: List(String),
    on_behalf_of_content_owner: option.Option(String),
    on_behalf_of_content_owner_channel: option.Option(String),
  )
}

Constructors

  • LiveStreamsInsertParams(
      part: List(String),
      on_behalf_of_content_owner: option.Option(String),
      on_behalf_of_content_owner_channel: option.Option(String),
    )

Retrieve the list of streams associated with the given channel. –

pub type LiveStreamsListParams {
  LiveStreamsListParams(
    part: List(String),
    id: option.Option(List(String)),
    max_results: option.Option(Int),
    mine: option.Option(Bool),
    on_behalf_of_content_owner: option.Option(String),
    on_behalf_of_content_owner_channel: option.Option(String),
    page_token: option.Option(String),
  )
}

Constructors

Updates an existing stream for the authenticated user.

pub type LiveStreamsUpdateParams {
  LiveStreamsUpdateParams(
    part: List(String),
    on_behalf_of_content_owner: option.Option(String),
    on_behalf_of_content_owner_channel: option.Option(String),
  )
}

Constructors

  • LiveStreamsUpdateParams(
      part: List(String),
      on_behalf_of_content_owner: option.Option(String),
      on_behalf_of_content_owner_channel: option.Option(String),
    )

Allows a user to load live chat through a server-streamed RPC. A call to this method has a quota cost of 5 units.

pub type YoutubeV3LiveChatMessagesStreamParams {
  YoutubeV3LiveChatMessagesStreamParams(
    hl: option.Option(String),
    live_chat_id: option.Option(String),
    max_results: option.Option(Int),
    page_token: option.Option(String),
    part: option.Option(List(String)),
    profile_image_size: option.Option(Int),
  )
}

Constructors

Values

pub fn live_broadcasts_bind(
  id: String,
  part: List(String),
) -> LiveBroadcastsBindParams
pub fn live_broadcasts_bind_add_part(
  params: LiveBroadcastsBindParams,
  value: String,
) -> LiveBroadcastsBindParams
pub fn live_broadcasts_bind_request(
  params: LiveBroadcastsBindParams,
) -> request.Request
pub fn live_broadcasts_bind_with_on_behalf_of_content_owner(
  params: LiveBroadcastsBindParams,
  value: String,
) -> LiveBroadcastsBindParams
pub fn live_broadcasts_bind_with_on_behalf_of_content_owner_channel(
  params: LiveBroadcastsBindParams,
  value: String,
) -> LiveBroadcastsBindParams
pub fn live_broadcasts_bind_with_stream_id(
  params: LiveBroadcastsBindParams,
  value: String,
) -> LiveBroadcastsBindParams
pub fn live_broadcasts_delete(
  id: String,
) -> LiveBroadcastsDeleteParams
pub fn live_broadcasts_delete_request(
  params: LiveBroadcastsDeleteParams,
) -> request.Request
pub fn live_broadcasts_delete_with_on_behalf_of_content_owner(
  params: LiveBroadcastsDeleteParams,
  value: String,
) -> LiveBroadcastsDeleteParams
pub fn live_broadcasts_delete_with_on_behalf_of_content_owner_channel(
  params: LiveBroadcastsDeleteParams,
  value: String,
) -> LiveBroadcastsDeleteParams
pub fn live_broadcasts_insert(
  part: List(String),
) -> LiveBroadcastsInsertParams
pub fn live_broadcasts_insert_add_part(
  params: LiveBroadcastsInsertParams,
  value: String,
) -> LiveBroadcastsInsertParams
pub fn live_broadcasts_insert_cuepoint_add_part(
  params: LiveBroadcastsInsertCuepointParams,
  value: String,
) -> LiveBroadcastsInsertCuepointParams
pub fn live_broadcasts_insert_cuepoint_with_id(
  params: LiveBroadcastsInsertCuepointParams,
  value: String,
) -> LiveBroadcastsInsertCuepointParams
pub fn live_broadcasts_insert_cuepoint_with_on_behalf_of_content_owner(
  params: LiveBroadcastsInsertCuepointParams,
  value: String,
) -> LiveBroadcastsInsertCuepointParams
pub fn live_broadcasts_insert_cuepoint_with_on_behalf_of_content_owner_channel(
  params: LiveBroadcastsInsertCuepointParams,
  value: String,
) -> LiveBroadcastsInsertCuepointParams
pub fn live_broadcasts_insert_cuepoint_with_part(
  params: LiveBroadcastsInsertCuepointParams,
  value: List(String),
) -> LiveBroadcastsInsertCuepointParams
pub fn live_broadcasts_insert_with_on_behalf_of_content_owner(
  params: LiveBroadcastsInsertParams,
  value: String,
) -> LiveBroadcastsInsertParams
pub fn live_broadcasts_insert_with_on_behalf_of_content_owner_channel(
  params: LiveBroadcastsInsertParams,
  value: String,
) -> LiveBroadcastsInsertParams
pub fn live_broadcasts_list(
  part: List(String),
) -> LiveBroadcastsListParams
pub fn live_broadcasts_list_add_id(
  params: LiveBroadcastsListParams,
  value: String,
) -> LiveBroadcastsListParams
pub fn live_broadcasts_list_add_part(
  params: LiveBroadcastsListParams,
  value: String,
) -> LiveBroadcastsListParams
pub fn live_broadcasts_list_broadcast_status_to_string(
  value: LiveBroadcastsListBroadcastStatus,
) -> String
pub fn live_broadcasts_list_broadcast_type_to_string(
  value: LiveBroadcastsListBroadcastType,
) -> String
pub fn live_broadcasts_list_request(
  params: LiveBroadcastsListParams,
) -> request.Request
pub fn live_broadcasts_list_with_id(
  params: LiveBroadcastsListParams,
  value: List(String),
) -> LiveBroadcastsListParams
pub fn live_broadcasts_list_with_max_results(
  params: LiveBroadcastsListParams,
  value: Int,
) -> LiveBroadcastsListParams
pub fn live_broadcasts_list_with_mine(
  params: LiveBroadcastsListParams,
  value: Bool,
) -> LiveBroadcastsListParams
pub fn live_broadcasts_list_with_on_behalf_of_content_owner(
  params: LiveBroadcastsListParams,
  value: String,
) -> LiveBroadcastsListParams
pub fn live_broadcasts_list_with_on_behalf_of_content_owner_channel(
  params: LiveBroadcastsListParams,
  value: String,
) -> LiveBroadcastsListParams
pub fn live_broadcasts_list_with_page_token(
  params: LiveBroadcastsListParams,
  value: String,
) -> LiveBroadcastsListParams
pub fn live_broadcasts_transition(
  broadcast_status: LiveBroadcastsTransitionBroadcastStatus,
  id: String,
  part: List(String),
) -> LiveBroadcastsTransitionParams
pub fn live_broadcasts_transition_add_part(
  params: LiveBroadcastsTransitionParams,
  value: String,
) -> LiveBroadcastsTransitionParams
pub fn live_broadcasts_transition_broadcast_status_to_string(
  value: LiveBroadcastsTransitionBroadcastStatus,
) -> String
pub fn live_broadcasts_transition_request(
  params: LiveBroadcastsTransitionParams,
) -> request.Request
pub fn live_broadcasts_transition_with_on_behalf_of_content_owner(
  params: LiveBroadcastsTransitionParams,
  value: String,
) -> LiveBroadcastsTransitionParams
pub fn live_broadcasts_transition_with_on_behalf_of_content_owner_channel(
  params: LiveBroadcastsTransitionParams,
  value: String,
) -> LiveBroadcastsTransitionParams
pub fn live_broadcasts_update(
  part: List(String),
) -> LiveBroadcastsUpdateParams
pub fn live_broadcasts_update_add_part(
  params: LiveBroadcastsUpdateParams,
  value: String,
) -> LiveBroadcastsUpdateParams
pub fn live_broadcasts_update_with_on_behalf_of_content_owner(
  params: LiveBroadcastsUpdateParams,
  value: String,
) -> LiveBroadcastsUpdateParams
pub fn live_broadcasts_update_with_on_behalf_of_content_owner_channel(
  params: LiveBroadcastsUpdateParams,
  value: String,
) -> LiveBroadcastsUpdateParams
pub fn live_chat_bans_delete(
  id: String,
) -> LiveChatBansDeleteParams
pub fn live_chat_bans_delete_request(
  params: LiveChatBansDeleteParams,
) -> request.Request
pub fn live_chat_bans_insert(
  part: List(String),
) -> LiveChatBansInsertParams
pub fn live_chat_bans_insert_add_part(
  params: LiveChatBansInsertParams,
  value: String,
) -> LiveChatBansInsertParams
pub fn live_chat_bans_insert_request(
  params: LiveChatBansInsertParams,
  body: live.LiveChatBan,
) -> request.Request
pub fn live_chat_messages_delete(
  id: String,
) -> LiveChatMessagesDeleteParams
pub fn live_chat_messages_delete_request(
  params: LiveChatMessagesDeleteParams,
) -> request.Request
pub fn live_chat_messages_insert(
  part: List(String),
) -> LiveChatMessagesInsertParams
pub fn live_chat_messages_insert_add_part(
  params: LiveChatMessagesInsertParams,
  value: String,
) -> LiveChatMessagesInsertParams
pub fn live_chat_messages_list(
  live_chat_id: String,
  part: List(String),
) -> LiveChatMessagesListParams
pub fn live_chat_messages_list_add_part(
  params: LiveChatMessagesListParams,
  value: String,
) -> LiveChatMessagesListParams
pub fn live_chat_messages_list_request(
  params: LiveChatMessagesListParams,
) -> request.Request
pub fn live_chat_messages_list_with_hl(
  params: LiveChatMessagesListParams,
  value: String,
) -> LiveChatMessagesListParams
pub fn live_chat_messages_list_with_max_results(
  params: LiveChatMessagesListParams,
  value: Int,
) -> LiveChatMessagesListParams
pub fn live_chat_messages_list_with_page_token(
  params: LiveChatMessagesListParams,
  value: String,
) -> LiveChatMessagesListParams
pub fn live_chat_messages_list_with_profile_image_size(
  params: LiveChatMessagesListParams,
  value: Int,
) -> LiveChatMessagesListParams
pub fn live_chat_messages_transition_request(
  params: LiveChatMessagesTransitionParams,
) -> request.Request
pub fn live_chat_messages_transition_status_to_string(
  value: LiveChatMessagesTransitionStatus,
) -> String
pub fn live_chat_messages_transition_with_id(
  params: LiveChatMessagesTransitionParams,
  value: String,
) -> LiveChatMessagesTransitionParams
pub fn live_chat_moderators_delete(
  id: String,
) -> LiveChatModeratorsDeleteParams
pub fn live_chat_moderators_delete_request(
  params: LiveChatModeratorsDeleteParams,
) -> request.Request
pub fn live_chat_moderators_insert(
  part: List(String),
) -> LiveChatModeratorsInsertParams
pub fn live_chat_moderators_insert_add_part(
  params: LiveChatModeratorsInsertParams,
  value: String,
) -> LiveChatModeratorsInsertParams
pub fn live_chat_moderators_list(
  live_chat_id: String,
  part: List(String),
) -> LiveChatModeratorsListParams
pub fn live_chat_moderators_list_add_part(
  params: LiveChatModeratorsListParams,
  value: String,
) -> LiveChatModeratorsListParams
pub fn live_chat_moderators_list_request(
  params: LiveChatModeratorsListParams,
) -> request.Request
pub fn live_chat_moderators_list_with_max_results(
  params: LiveChatModeratorsListParams,
  value: Int,
) -> LiveChatModeratorsListParams
pub fn live_chat_moderators_list_with_page_token(
  params: LiveChatModeratorsListParams,
  value: String,
) -> LiveChatModeratorsListParams
pub fn live_streams_delete(id: String) -> LiveStreamsDeleteParams
pub fn live_streams_delete_request(
  params: LiveStreamsDeleteParams,
) -> request.Request
pub fn live_streams_delete_with_on_behalf_of_content_owner(
  params: LiveStreamsDeleteParams,
  value: String,
) -> LiveStreamsDeleteParams
pub fn live_streams_delete_with_on_behalf_of_content_owner_channel(
  params: LiveStreamsDeleteParams,
  value: String,
) -> LiveStreamsDeleteParams
pub fn live_streams_insert(
  part: List(String),
) -> LiveStreamsInsertParams
pub fn live_streams_insert_add_part(
  params: LiveStreamsInsertParams,
  value: String,
) -> LiveStreamsInsertParams
pub fn live_streams_insert_request(
  params: LiveStreamsInsertParams,
  body: live.LiveStream,
) -> request.Request
pub fn live_streams_insert_with_on_behalf_of_content_owner(
  params: LiveStreamsInsertParams,
  value: String,
) -> LiveStreamsInsertParams
pub fn live_streams_insert_with_on_behalf_of_content_owner_channel(
  params: LiveStreamsInsertParams,
  value: String,
) -> LiveStreamsInsertParams
pub fn live_streams_list(
  part: List(String),
) -> LiveStreamsListParams
pub fn live_streams_list_add_id(
  params: LiveStreamsListParams,
  value: String,
) -> LiveStreamsListParams
pub fn live_streams_list_add_part(
  params: LiveStreamsListParams,
  value: String,
) -> LiveStreamsListParams
pub fn live_streams_list_request(
  params: LiveStreamsListParams,
) -> request.Request
pub fn live_streams_list_with_id(
  params: LiveStreamsListParams,
  value: List(String),
) -> LiveStreamsListParams
pub fn live_streams_list_with_max_results(
  params: LiveStreamsListParams,
  value: Int,
) -> LiveStreamsListParams
pub fn live_streams_list_with_mine(
  params: LiveStreamsListParams,
  value: Bool,
) -> LiveStreamsListParams
pub fn live_streams_list_with_on_behalf_of_content_owner(
  params: LiveStreamsListParams,
  value: String,
) -> LiveStreamsListParams
pub fn live_streams_list_with_on_behalf_of_content_owner_channel(
  params: LiveStreamsListParams,
  value: String,
) -> LiveStreamsListParams
pub fn live_streams_list_with_page_token(
  params: LiveStreamsListParams,
  value: String,
) -> LiveStreamsListParams
pub fn live_streams_update(
  part: List(String),
) -> LiveStreamsUpdateParams
pub fn live_streams_update_add_part(
  params: LiveStreamsUpdateParams,
  value: String,
) -> LiveStreamsUpdateParams
pub fn live_streams_update_request(
  params: LiveStreamsUpdateParams,
  body: live.LiveStream,
) -> request.Request
pub fn live_streams_update_with_on_behalf_of_content_owner(
  params: LiveStreamsUpdateParams,
  value: String,
) -> LiveStreamsUpdateParams
pub fn live_streams_update_with_on_behalf_of_content_owner_channel(
  params: LiveStreamsUpdateParams,
  value: String,
) -> LiveStreamsUpdateParams
pub fn youtube_v3_live_chat_messages_stream_add_part(
  params: YoutubeV3LiveChatMessagesStreamParams,
  value: String,
) -> YoutubeV3LiveChatMessagesStreamParams
pub fn youtube_v3_live_chat_messages_stream_with_live_chat_id(
  params: YoutubeV3LiveChatMessagesStreamParams,
  value: String,
) -> YoutubeV3LiveChatMessagesStreamParams
pub fn youtube_v3_live_chat_messages_stream_with_page_token(
  params: YoutubeV3LiveChatMessagesStreamParams,
  value: String,
) -> YoutubeV3LiveChatMessagesStreamParams
pub fn youtube_v3_live_chat_messages_stream_with_part(
  params: YoutubeV3LiveChatMessagesStreamParams,
  value: List(String),
) -> YoutubeV3LiveChatMessagesStreamParams
pub fn youtube_v3_live_chat_messages_stream_with_profile_image_size(
  params: YoutubeV3LiveChatMessagesStreamParams,
  value: Int,
) -> YoutubeV3LiveChatMessagesStreamParams
✨ Search Document