Dela via


CallMedia class

Klassen CallMedia representerar samtalsmedierelaterade API:er.

Konstruktorer

CallMedia(string, string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)

Metoder

cancelAllOperations()

Avbryter alla köade medieåtgärder.

hold(CommunicationIdentifier, HoldOptions)

Lägg deltagaren på paus medan du spelar upp ljud.

play((FileSource | TextSource | SsmlSource)[], CommunicationIdentifier[], PlayOptions)

Spela upp ljud till en specifik deltagare.

playToAll((FileSource | TextSource | SsmlSource)[], PlayToAllOptions)

Spela för alla deltagare.

sendDtmfTones(string[] | DtmfTone[], CommunicationIdentifier, SendDtmfTonesOptions)

Skicka Dtmf-toner.

startContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)

Starta kontinuerlig Dtmf-igenkänning genom att prenumerera på toner.

startMediaStreaming(StartMediaStreamingOptions)

Startar medieströmning i anropet.

startRecognizing(CommunicationIdentifier, CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions)

Identifiera deltagarens indata.

startRecognizing(CommunicationIdentifier, number, CallMediaRecognizeDtmfOptions)

Identifiera deltagarens indata.

startTranscription(StartTranscriptionOptions)

Startar transkription i anropet

stopContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)

Stoppa kontinuerlig Dtmf-igenkänning genom att avbryta prenumerationen på toner.

stopMediaStreaming(StopMediaStreamingOptions)

Stoppar medieströmning i anropet.

stopTranscription(StopTranscriptionOptions)

Stoppar transkriptionen i samtalet.

unhold(CommunicationIdentifier, UnholdOptions)

Ta bort deltagare från undantag.

updateTranscription(string, UpdateTranscriptionOptions)

Uppdatera transkriptionsspråket.

Konstruktorinformation

CallMedia(string, string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)

new CallMedia(callConnectionId: string, endpoint: string, credential: TokenCredential | KeyCredential, options?: CallAutomationApiClientOptionalParams)

Parametrar

callConnectionId

string

endpoint

string

options

CallAutomationApiClientOptionalParams

Metodinformation

cancelAllOperations()

Avbryter alla köade medieåtgärder.

function cancelAllOperations(): Promise<void>

Returer

Promise<void>

hold(CommunicationIdentifier, HoldOptions)

Lägg deltagaren på paus medan du spelar upp ljud.

function hold(targetParticipant: CommunicationIdentifier, options?: HoldOptions): Promise<void>

Parametrar

targetParticipant
CommunicationIdentifier

Målen att spela till.

options
HoldOptions

Ytterligare attribut för undantagsdeltagare.

Returer

Promise<void>

play((FileSource | TextSource | SsmlSource)[], CommunicationIdentifier[], PlayOptions)

Spela upp ljud till en specifik deltagare.

function play(playSources: (FileSource | TextSource | SsmlSource)[], playTo: CommunicationIdentifier[], options?: PlayOptions): Promise<void>

Parametrar

playSources

(FileSource | TextSource | SsmlSource)[]

En PlaySource som representerar de källor som ska spelas upp. För närvarande stöds endast en enda uppspelningskälla per begäran.

playTo

CommunicationIdentifier[]

Målen att spela till.

options
PlayOptions

Ytterligare attribut för uppspelning.

Returer

Promise<void>

playToAll((FileSource | TextSource | SsmlSource)[], PlayToAllOptions)

Spela för alla deltagare.

function playToAll(playSources: (FileSource | TextSource | SsmlSource)[], options?: PlayToAllOptions): Promise<void>

Parametrar

playSources

(FileSource | TextSource | SsmlSource)[]

En PlaySource som representerar de källor som ska spelas upp. För närvarande stöds endast en enda uppspelningskälla per begäran.

options
PlayToAllOptions

Ytterligare attribut för uppspelning.

Returer

Promise<void>

sendDtmfTones(string[] | DtmfTone[], CommunicationIdentifier, SendDtmfTonesOptions)

Skicka Dtmf-toner.

function sendDtmfTones(tones: string[] | DtmfTone[], targetParticipant: CommunicationIdentifier, options?: SendDtmfTonesOptions): Promise<SendDtmfTonesResult>

Parametrar

tones

string[] | DtmfTone[]

Lista över toner som ska skickas till måldeltagaren.

targetParticipant
CommunicationIdentifier

Måldeltagare.

options
SendDtmfTonesOptions

Ytterligare attribut för att skicka Dtmf-toner.

Returer

startContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)

Starta kontinuerlig Dtmf-igenkänning genom att prenumerera på toner.

function startContinuousDtmfRecognition(targetParticipant: CommunicationIdentifier, options?: ContinuousDtmfRecognitionOptions): Promise<void>

Parametrar

targetParticipant
CommunicationIdentifier

Måldeltagare.

options
ContinuousDtmfRecognitionOptions

Ytterligare attribut för kontinuerlig Dtmf-igenkänning.

Returer

Promise<void>

startMediaStreaming(StartMediaStreamingOptions)

Startar medieströmning i anropet.

function startMediaStreaming(options?: StartMediaStreamingOptions): Promise<void>

Parametrar

options
StartMediaStreamingOptions

Ytterligare attribut för att starta direktuppspelning av media.

Returer

Promise<void>

startRecognizing(CommunicationIdentifier, CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions)

Identifiera deltagarens indata.

function startRecognizing(targetParticipant: CommunicationIdentifier, options: CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions): Promise<void>

Parametrar

targetParticipant
CommunicationIdentifier

Måldeltagare.

Returer

Promise<void>

startRecognizing(CommunicationIdentifier, number, CallMediaRecognizeDtmfOptions)

Varning

Det här API:et är nu inaktuellt.

This method signature is deprecated. Please use the new signature with targetParticipant and options params instead, and set maxTonesToCollect in options.

Identifiera deltagarens indata.

function startRecognizing(targetParticipant: CommunicationIdentifier, maxTonesToCollect: number, options: CallMediaRecognizeDtmfOptions): Promise<void>

Parametrar

targetParticipant
CommunicationIdentifier

Måldeltagare.

maxTonesToCollect

number

Maximalt antal DTMF-toner som ska samlas in.

options
CallMediaRecognizeDtmfOptions

Olika attribut för att identifiera.

Returer

Promise<void>

startTranscription(StartTranscriptionOptions)

Startar transkription i anropet

function startTranscription(options?: StartTranscriptionOptions): Promise<void>

Parametrar

options
StartTranscriptionOptions

Ytterligare attribut för starttranskription.

Returer

Promise<void>

stopContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)

Stoppa kontinuerlig Dtmf-igenkänning genom att avbryta prenumerationen på toner.

function stopContinuousDtmfRecognition(targetParticipant: CommunicationIdentifier, options?: ContinuousDtmfRecognitionOptions): Promise<void>

Parametrar

targetParticipant
CommunicationIdentifier

Måldeltagare.

options
ContinuousDtmfRecognitionOptions

Ytterligare attribut för kontinuerlig Dtmf-igenkänning.

Returer

Promise<void>

stopMediaStreaming(StopMediaStreamingOptions)

Stoppar medieströmning i anropet.

function stopMediaStreaming(options?: StopMediaStreamingOptions): Promise<void>

Parametrar

options
StopMediaStreamingOptions

Ytterligare attribut för att stoppa medieströmning.

Returer

Promise<void>

stopTranscription(StopTranscriptionOptions)

Stoppar transkriptionen i samtalet.

function stopTranscription(options?: StopTranscriptionOptions): Promise<void>

Parametrar

options
StopTranscriptionOptions

Ytterligare attribut för stopptranskription.

Returer

Promise<void>

unhold(CommunicationIdentifier, UnholdOptions)

Ta bort deltagare från undantag.

function unhold(targetParticipant: CommunicationIdentifier, options?: UnholdOptions): Promise<void>

Parametrar

targetParticipant
CommunicationIdentifier

Målen att spela till.

options
UnholdOptions

Ytterligare attribut för deltagare som inte håller inne.

Returer

Promise<void>

updateTranscription(string, UpdateTranscriptionOptions)

Uppdatera transkriptionsspråket.

function updateTranscription(locale: string, options?: UpdateTranscriptionOptions): Promise<void>

Parametrar

locale

string

Definierar ett nytt språk för transkription.

Returer

Promise<void>