api

yt-cast-receiver

yt-cast-receiver

Table of contents

Classes

• AbortError
• AppError
• BadResponseError
• ConnectionError
• DataError
• DataStore
• DefaultDataStore
• DefaultLogger
• DefaultPlaylistRequestHandler
• DialServerError
• IncompleteAPIDataError
• PairingCodeRequestService
• Player
• Playlist
• PlaylistRequestHandler
• Sender
• SenderConnectionError
• SessionError
• YouTubeCastReceiver
• YouTubeCastReceiverError

Interfaces

• AppOptions
• Client
• DialOptions
• Logger
• PlayerNavInfo
• PlayerState
• PlaylistEvent
• PlaylistPreviousNextVideos
• PlaylistState
• Video
• Volume
• YouTubeCastReceiverOptions

Type Aliases

• AutoplayMode
• ClientKey
• LogLevel
• PlayerStatus
• PlaylistEventType
• YouTubeCastReceiverStatus

Variables

• AUTOPLAY_MODES
• CLIENTS
• CONF_DEFAULTS
• LOG_LEVELS
• MUTE_POLICIES
• PLAYER_STATUSES
• PLAYLIST_EVENT_TYPES
• RESET_PLAYER_ON_DISCONNECT_POLICIES
• STATUSES

Type Aliases

AutoplayMode

Ƭ AutoplayMode: ValueOf<typeof AUTOPLAY_MODES>

One of the values in AUTOPLAY_MODES.

Defined in

src/lib/Player.ts:12

---

ClientKey

Ƭ ClientKey: "YT" | "YTMUSIC"

Defined in

src/lib/app/Client.ts:1

---

LogLevel

Ƭ LogLevel: ValueOf<typeof LOG_LEVELS>

One of the values in LOG_LEVELS.

Defined in

src/lib/utils/Logger.ts:7

---

PlayerStatus

Ƭ PlayerStatus: ValueOf<typeof PLAYER_STATUSES>

One of the values in PLAYER_STATUSES.

Defined in

src/lib/Player.ts:17

---

PlaylistEventType

Ƭ PlaylistEventType: ValueOf<typeof PLAYLIST_EVENT_TYPES>

Defined in

src/lib/app/Playlist.ts:31

---

YouTubeCastReceiverStatus

Ƭ YouTubeCastReceiverStatus: ValueOf<typeof STATUSES>

One of the values in STATUSES.

Defined in

src/lib/YouTubeCastReceiver.ts:55

Variables

AUTOPLAY_MODES

• Const AUTOPLAY_MODES: Object

Type declaration

Name	Type
DISABLED	"DISABLED"
ENABLED	"ENABLED"
UNSUPPORTED	"UNSUPPORTED"

Defined in

src/lib/Constants.ts:23

---

CLIENTS

• Const CLIENTS: Record<ClientKey, Client>

Defined in

src/lib/Constants.ts:52

---

CONF_DEFAULTS

• Const CONF_DEFAULTS: Object

Type declaration

Name	Type
BRAND	"Generic"
MODEL	"SmartTV"
SCREEN_APP	"ytcr"

Defined in

src/lib/Constants.ts:17

---

LOG_LEVELS

• Const LOG_LEVELS: Object

Type declaration

Name	Type
DEBUG	"debug"
ERROR	"error"
INFO	"info"
NONE	"none"
WARN	"warn"

Defined in

src/lib/Constants.ts:37

---

MUTE_POLICIES

• Const MUTE_POLICIES: Object

Type declaration

Name	Type
AUTO	"auto"
PRESERVE_VOLUME_LEVEL	"preserveLevel"
ZERO_VOLUME_LEVEL	"zeroLevel"

Defined in

src/lib/Constants.ts:65

---

PLAYER_STATUSES

• Const PLAYER_STATUSES: Object

Type declaration

Name	Type
IDLE	-1
LOADING	3
PAUSED	2
PLAYING	1
STOPPED	4

Defined in

src/lib/Constants.ts:29

---

PLAYLIST_EVENT_TYPES

• Const PLAYLIST_EVENT_TYPES: Object

Type declaration

Name	Type
PLAYLIST_ADDED	"playlistAdded"
PLAYLIST_CLEARED	"playlistCleared"
PLAYLIST_SET	"playlistSet"
PLAYLIST_UPDATED	"playlistUpdated"
VIDEO_ADDED	"videoAdded"
VIDEO_REMOVED	"videoRemoved"
VIDEO_SELECTED	"videoSelected"

Defined in

src/lib/app/Playlist.ts:12

---

RESET_PLAYER_ON_DISCONNECT_POLICIES

• Const RESET_PLAYER_ON_DISCONNECT_POLICIES: Object

Type declaration

Name	Type
ALL_DISCONNECTED	"allDisconnected"
ALL_EXPLICITLY_DISCONNECTED	"allExplicitlyDisconnected"

Defined in

src/lib/Constants.ts:71

---

STATUSES

• Const STATUSES: Object

Type declaration

Name	Type
RUNNING	"running"
STARTING	"starting"
STOPPED	"stopped"
STOPPING	"stopping"

Defined in

src/lib/Constants.ts:45