PlatformSender | @amilajack/castv2-client

Hierarchy

Sender
- PlatformSender

Index

Constructors

constructor

Properties

Constructors

constructor

new PlatformSender(): PlatformSender

Overrides Sender.constructor
- Defined in senders/platform.ts:7
Returns PlatformSender

Properties

client

client: Client

receiverId

receiverId: string | undefined

senderId

senderId: string | undefined

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

Overrides Sender.close
- Defined in senders/platform.ts:74
Close

Returns void

connect

connect(options: any): Promise<Object>

- Defined in senders/platform.ts:34
Connect

Parameters
- options: any
  
  Options
Returns Promise<Object>

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>

getAppAvailability

getAppAvailability(appId: any): Promise<Object>

- Defined in senders/platform.ts:99
Get app availability

Parameters
- appId: any
  
  App ID
Returns Promise<Object>

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

getSessions

getSessions(): any

- Defined in senders/platform.ts:90
Get the sessions

Returns any

getStatus

getStatus(): any

- Defined in senders/platform.ts:82
Get the status

Returns any

getVolume

getVolume(): any

- Defined in senders/platform.ts:162
Get the volume

Returns any

join

join(session: any, application: any): Promise<Object>

- Defined in senders/platform.ts:116
Join

Parameters
- session: any
  
  Session
- application: any
  
  Application
Returns Promise<Object>

launch

launch(application: any): Promise<Object>

- Defined in senders/platform.ts:127
Launch an application

Parameters
- application: any
  
  Application
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[]

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

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

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

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

setVolume

setVolume(volume: Object): any

- Defined in senders/platform.ts:154
Set the volume

Parameters
- volume: Object
  
  Volume
Returns any

stop

stop(application: any): any

- Defined in senders/platform.ts:143
Close an application and stop it

Parameters
- application: any
  
  Application to stop
Returns any

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