google_youtube_api_v3 - v2.0.0

google_youtube_api_v3/youtube/caption

Types

AudioTrackType

</>

The type of audio track associated with the caption track.

pub type AudioTrackType {
  AudioTrackTypeUnknown
  AudioTrackTypePrimary
  AudioTrackTypeCommentary
  AudioTrackTypeDescriptive
}

Constructors 

  • AudioTrackTypeUnknown
  • AudioTrackTypePrimary
  • AudioTrackTypeCommentary
  • AudioTrackTypeDescriptive

Caption

</>

A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.

pub type Caption {
  Caption(
    etag: option.Option(String),
    id: option.Option(String),
    kind: option.Option(String),
    snippet: option.Option(CaptionSnippet),
  )
}

Constructors

CaptionListResponse

</> 
pub type CaptionListResponse {
  CaptionListResponse(
    etag: option.Option(String),
    event_id: option.Option(String),
    items: option.Option(List(Caption)),
    kind: option.Option(String),
    visitor_id: option.Option(String),
  )
}

Constructors

CaptionSnippet

</>

Basic details about a caption track, such as its language and name.

pub type CaptionSnippet {
  CaptionSnippet(
    audio_track_type: option.Option(AudioTrackType),
    failure_reason: option.Option(FailureReason),
    is_auto_synced: option.Option(Bool),
    is_cc: option.Option(Bool),
    is_draft: option.Option(Bool),
    is_easy_reader: option.Option(Bool),
    is_large: option.Option(Bool),
    language: option.Option(String),
    last_updated: option.Option(String),
    name: option.Option(String),
    status: option.Option(Status),
    track_kind: option.Option(TrackKind),
    video_id: option.Option(String),
  )
}

Constructors

FailureReason

</>

The reason that YouTube failed to process the caption track. This property is only present if the state property’s value is failed.

pub type FailureReason {
  FailureReasonUnknownFormat
  FailureReasonUnsupportedFormat
  FailureReasonProcessingFailed
}

Constructors 

  • FailureReasonUnknownFormat
  • FailureReasonUnsupportedFormat
  • FailureReasonProcessingFailed

Status

</>

The caption track’s status.

pub type Status {
  StatusServing
  StatusSyncing
  StatusFailed
}

Constructors 

  • StatusServing
  • StatusSyncing
  • StatusFailed

TrackKind

</>

The caption track’s type.

pub type TrackKind {
  TrackKindStandard
  TrackKindAsr
  TrackKindForced
}

Constructors 

  • TrackKindStandard
  • TrackKindAsr
  • TrackKindForced

Values

audio_track_type_decoder

</> 
pub fn audio_track_type_decoder() -> decode.Decoder(
  AudioTrackType,
)

audio_track_type_to_string

</> 
pub fn audio_track_type_to_string(
  value: AudioTrackType,
) -> String

caption_decoder

</> 
pub fn caption_decoder() -> decode.Decoder(Caption)

caption_list_response_decoder

</> 
pub fn caption_list_response_decoder() -> decode.Decoder(
  CaptionListResponse,
)

caption_list_response_to_json

</> 
pub fn caption_list_response_to_json(
  value: CaptionListResponse,
) -> json.Json

caption_snippet_decoder

</> 
pub fn caption_snippet_decoder() -> decode.Decoder(CaptionSnippet)

caption_snippet_to_json

</> 
pub fn caption_snippet_to_json(
  value: CaptionSnippet,
) -> json.Json

caption_to_json

</> 
pub fn caption_to_json(value: Caption) -> json.Json

failure_reason_decoder

</> 
pub fn failure_reason_decoder() -> decode.Decoder(FailureReason)

failure_reason_to_string

</> 
pub fn failure_reason_to_string(value: FailureReason) -> String

status_decoder

</> 
pub fn status_decoder() -> decode.Decoder(Status)

status_to_string

</> 
pub fn status_to_string(value: Status) -> String

track_kind_decoder

</> 
pub fn track_kind_decoder() -> decode.Decoder(TrackKind)

track_kind_to_string

</> 
pub fn track_kind_to_string(value: TrackKind) -> String
✨ Search Document