MediaController | @amilajack/castv2-client

Hierarchy

RequestResponseController
- MediaController

Index

Constructors

constructor

Properties

Constructors

constructor

new MediaController(client: Client, sourceId: string, destinationId: string): MediaController

Overrides RequestResponseController.constructor
- Defined in controllers/media.ts:4
Parameters
- client: Client
- sourceId: string
- destinationId: string
Returns MediaController

Properties

lastRequestId

lastRequestId: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:10
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

close

close(): void

Inherited from Controller.close
- Defined in controllers/controller.ts:35
Close the channel

Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:23
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:19
Returns number

getStatus

getStatus(): Promise<Object>

- Defined in controllers/media.ts:31
Get the status

Returns Promise<Object>

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:24
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:20
Parameters
- event: string | symbol
Returns Function[]

load

load(media: any, options?: object): Promise<Object>

- Defined in controllers/media.ts:50
Load media

Parameters
- media: any
- Default value options: object = {}
Returns Promise<Object>

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:11
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:12
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

pause

pause(): Promise<Object>

- Defined in controllers/media.ts:101
Pause the media

Returns Promise<Object>

play

play(): Promise<Object>

- Defined in controllers/media.ts:88
Play the media

Returns Promise<Object>

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:13
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:14
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

queueInsert

queueInsert(items: Object[], options: Object): Promise<Object>

- Defined in controllers/media.ts:170
Insert items into the queue

Parameters
- items: Object[]
  
  Items to insert
- options: Object
  
  Options
Returns Promise<Object>

queueLoad

queueLoad(items: Object[], options?: Object): Promise<Object>

- Defined in controllers/media.ts:145
Load a queue of items to play (playlist)

see

https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueLoadRequest

Parameters
- items: Object[]
  
  Items to load into the queue
- Default value options: Object = {}
  
  Options
Returns Promise<Object>

queueRemove

queueRemove(itemIds: string[], options: Object): Promise<Object>

- Defined in controllers/media.ts:187
Remove items from the queue

Parameters
- itemIds: string[]
  
  IDs to remove
- options: Object
  
  Options
Returns Promise<Object>

queueReorder

queueReorder(itemIds: string[], options: Object): Promise<Object>

- Defined in controllers/media.ts:204
Reorder the queue

Parameters
- itemIds: string[]
  
  IDs to reorder
- options: Object
  
  Options
Returns Promise<Object>

queueUpdate

queueUpdate(items: Object[], options: Object): Promise<Object>

- Defined in controllers/media.ts:221
Update the queue

Parameters
- items: Object[]
  
  Items
- options: Object
  
  Options
Returns Promise<Object>

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:17
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:15
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

request

request(data: Record<string, any>): Promise<Response>

Inherited from RequestResponseController.request
- Defined in controllers/request-response.ts:22
Object to request

Parameters
- data: Record<string, any>
  
  data
Returns Promise<Response>

seek

seek(currentTime: any): Promise<Object>

- Defined in controllers/media.ts:128
Seek through the media

Parameters
- currentTime: any
  
  Time to seek to
Returns Promise<Object>

send

send(data: Record<string, string>): void

Inherited from Controller.send
- Defined in controllers/controller.ts:27
Send data over the channel

Parameters
- data: Record<string, string>
  
  Data to send
Returns void

sessionRequest

sessionRequest(data: any): Promise<Object>

- Defined in controllers/media.ts:74
Session request

Parameters
- data: any
Returns Promise<Object>

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:18
Parameters
- n: number
Returns this

stop

stop(): Promise<Object>

- Defined in controllers/media.ts:114
Stop the media

Returns Promise<Object>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in /Users/amila/Documents/Projects/castv2-client/node_modules/@types/node/events.d.ts:7
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc