Package version:

Interface StartRecordingOptions

Options to get a start a recording.

interface StartRecordingOptions {
    audioChannelParticipantOrdering?: CommunicationIdentifier[];
    callLocator: CallLocator;
    channelAffinity?: ChannelAffinity[];
    pauseOnStart?: boolean;
    recordingChannel?: RecordingChannel;
    recordingContent?: RecordingContent;
    recordingFormat?: RecordingFormat;
    recordingStateCallbackEndpointUrl?: string;
    recordingStorage?: RecordingStorage;
}

Hierarchy

  • unknown
    • StartRecordingOptions

Properties

audioChannelParticipantOrdering? callLocator channelAffinity? pauseOnStart? recordingChannel? recordingContent? recordingFormat? recordingStateCallbackEndpointUrl? recordingStorage?

Properties

OptionalaudioChannelParticipantOrdering

audioChannelParticipantOrdering?: CommunicationIdentifier[]

The sequential order in which audio channels are assigned to participants in the unmixed recording. When 'recordingChannelType' is set to 'unmixed' and audioChannelParticipantOrdering is not specified, the audio channel to participant mapping will be automatically assigned based on the order in which participant first audio was detected. Channel to participant mapping details can be found in the metadata of the recording.

callLocator

callLocator: CallLocator

The call locator.

OptionalchannelAffinity

channelAffinity?: ChannelAffinity[]

The channel affinity of call recording When 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified, 'channel' will be automatically assigned. Channel-Participant mapping details can be found in the metadata of the recording.

OptionalpauseOnStart

pauseOnStart?: boolean

Pause on start call recording option.

OptionalrecordingChannel

recordingChannel?: RecordingChannel

The channel type of call recording.

OptionalrecordingContent

recordingContent?: RecordingContent

The content type of call recording.

OptionalrecordingFormat

recordingFormat?: RecordingFormat

The format type of call recording.

OptionalrecordingStateCallbackEndpointUrl

recordingStateCallbackEndpointUrl?: string

The url to send notifications to.

OptionalrecordingStorage

recordingStorage?: RecordingStorage

Recording storage option.

Settings

Member Visibility