Class HMSAudioFilePlayerNode

Hierarchy

HMSAudioNode
- HMSAudioFilePlayerNode

Index

Constructors

Properties

Methods

currentDuration duration isPlaying pause play resume setVolume stop toString

Constructors

constructor

new HMSAudioFilePlayerNode(name): HMSAudioFilePlayerNode
Parameters
- name: string
Returns HMSAudioFilePlayerNode
Overrides HMSAudioNode.constructor
- Defined in src/classes/HMSAudioFilePlayerNode.ts:12

Properties

name

name: string

sdkId

sdkId: string = HMSConstants.DEFAULT_SDK_ID

Methods

currentDuration

currentDuration(): Promise<any>
Returns Promise<any>
- Defined in src/classes/HMSAudioFilePlayerNode.ts:62

duration

duration(): Promise<any>
Returns Promise<any>
- Defined in src/classes/HMSAudioFilePlayerNode.ts:69

isPlaying

isPlaying(): Promise<any>
Returns Promise<any>
- Defined in src/classes/HMSAudioFilePlayerNode.ts:55

pause

pause(): void
Returns void
- Defined in src/classes/HMSAudioFilePlayerNode.ts:34

play

play(fileUrl, loops?, interrupts?): Promise<any>
Parameters
- fileUrl: string
- Optional loops: boolean
- Optional interrupts: boolean
Returns Promise<any>
- Defined in src/classes/HMSAudioFilePlayerNode.ts:24

resume

resume(): void
Returns void
- Defined in src/classes/HMSAudioFilePlayerNode.ts:41

setVolume

setVolume(volume): void
Parameters
- volume: number
Returns void
- Defined in src/classes/HMSAudioFilePlayerNode.ts:16

stop

stop(): void
Returns void
- Defined in src/classes/HMSAudioFilePlayerNode.ts:48

toString

toString(): string
Returns string
Inherited from HMSAudioNode.toString
- Defined in src/classes/HMSAudioNode.ts:11

Generated using TypeDoc