DefaultMediaReceiver | @amilajack/castv2-client

Hierarchy

Application
- DefaultMediaReceiver

Index

Constructors

constructor

Properties

Constructors

constructor

new DefaultMediaReceiver(client: Client, session: any): DefaultMediaReceiver

Overrides Application.constructor
- Defined in senders/default-media-receiver.ts:9
Parameters
- client: Client
- session: any
Returns DefaultMediaReceiver

Properties

APP_ID

APP_ID: string = "CC1AD845"

client

client: Client

receiverId

receiverId: string | undefined

senderId

senderId: string | undefined

Static APP_ID

APP_ID: string = "CC1AD845"

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 Application.close

Overrides Sender.close
- Defined in senders/application.ts:37
Returns void

createController

createController(Controller: Controller, ...args: any[]): any

Inherited from Sender.createController
- Defined in senders/sender.ts:33
Create a controller using the Sender's properties

Parameters
- Controller: Controller
- Rest ...args: any[]
Returns any

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(): any

- Defined in senders/default-media-receiver.ts:41
Get the status

Returns any

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): any

- Defined in senders/default-media-receiver.ts:51
Load a media object

Parameters
- media: any
  
  Media to load
- Default value options: object = {}
Returns any

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(): any

- Defined in senders/default-media-receiver.ts:67
Pause the media

Returns any

play

play(): any

- Defined in senders/default-media-receiver.ts:59
Play the media

Returns any

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: any, options?: object): any

- Defined in senders/default-media-receiver.ts:104
Insert items into the queue

Parameters
- items: any
  
  Items to insert
- Default value options: object = {}
  
  Options
Returns any

queueLoad

queueLoad(items: any, options?: object): any

- Defined in senders/default-media-receiver.ts:94
Load a queue of items to play (playlist)

see

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

Parameters
- items: any
  
  Items to load into the queue
- Default value options: object = {}
  
  Options
Returns any

queueRemove

queueRemove(itemIds: any, options?: object): any

- Defined in senders/default-media-receiver.ts:114
Remove items from the queue

Parameters
- itemIds: any
  
  IDs to remove
- Default value options: object = {}
  
  Options
Returns any

queueReorder

queueReorder(itemIds: any, options?: object): any

- Defined in senders/default-media-receiver.ts:124
Reorder the queue

Parameters
- itemIds: any
  
  IDs to reorder
- Default value options: object = {}
  
  Options
Returns any

queueUpdate

queueUpdate(items: any, options?: object): any

- Defined in senders/default-media-receiver.ts:134
Update the queue

Parameters
- items: any
  
  Items
- Default value options: object = {}
  
  Options
Returns any

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

seek

seek(currentTime: any): any

- Defined in senders/default-media-receiver.ts:83
Seek through the media

Parameters
- currentTime: any
  
  Time to seek to
Returns any

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(): any

- Defined in senders/default-media-receiver.ts:75
Stop the media

Returns any

superClose

superClose(): void

Inherited from Application.superClose
- Defined in senders/application.ts:33
Returns void

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