PlayToAllOptions interface

Package:

@azure/communication-call-automation

Options to playToAll audio.

Extends

PlayOptions

Properties

interruptCallMediaOperation

If set play can barge into other existing queued-up/currently-processing requests.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
loop	Determine if it is looping
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
operationCallbackUrl	Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
operationContext	The value to identify context of the operation.
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	Options used when tracing is enabled.

Property Details

interruptCallMediaOperation

If set play can barge into other existing queued-up/currently-processing requests.

interruptCallMediaOperation?: boolean

Property Value

boolean

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From PlayOptions.abortSignal

loop

Determine if it is looping

loop?: boolean

Property Value

boolean

Inherited From PlayOptions.loop

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From PlayOptions.onResponse

operationCallbackUrl

Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.

operationCallbackUrl?: string

Property Value

string

Inherited From PlayOptions.operationCallbackUrl

operationContext

The value to identify context of the operation.

operationContext?: string

Property Value

string

Inherited From PlayOptions.operationContext

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From PlayOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From PlayOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From PlayOptions.tracingOptions