For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Platform docsVideosCommunitySign up
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
      • Overview
        • Player
        • PlayerEvents
        • StreamingAgent
        • StreamingAgentEvents
        • SequencePlayer
        • SequencePlayerEvents
        • Recorder
        • RecorderDirection
        • RecorderEvents
        • RecorderLabelFont
        • RecorderLabelPosition
        • RecorderLabelTextAlign
        • RecorderLayout
        • RecorderObjectFit
        • RecorderProfile
        • RecordExpireTime
        • URLPlayerRequestMethod
  • Management API
    • Reference
    • Authorization
    • Errors
  • Web SDK
    • Overview
  • Android SDK
    • Overview
  • Android SDK v3
    • Overview
  • iOS SDK
    • Overview
  • React Native SDK
    • Overview
  • Flutter SDK
    • Overview
LogoLogo
Platform docsVideosCommunitySign up
On this page
  • Methods
  • addEventListener
  • id
  • mute
  • removeEventListener
  • stop
VoxEngineMedia playback and recording

Recorder

Represents an audio and video recorder. Add the following line to your scenario code to use the class: require(Modules.Recorder);

||View as Markdown|
Was this page helpful?
Edit this page
Previous

SequencePlayerEvents

Next

RecorderDirection

Built with

Methods

addEventListener

Adds a handler for the specified RecorderEvents event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

1addEventListener(event: RecorderEvents | T, callback: (event: _RecorderEvents[T]) => any): void

Parameters

event
RecorderEvents | TRequired
callback
(event: _RecorderEvents[T]) => anyRequired

id

Returns the recorder’s id.

1id(): string

mute

Whether to mute whole record without detaching media sources from it.

1mute(doMute: boolean): void

Parameters

doMute
booleanRequired

removeEventListener

Removes a handler for the specified RecorderEvents event.

1removeEventListener(event: RecorderEvents | T, callback?: (event: _RecorderEvents[T]) => any): void

Parameters

event
RecorderEvents | TRequired
callback
(event: _RecorderEvents[T]) => any

stop

Stops recording and triggers the RecorderEvents.Stopped event.

1stop(): void