MediaStreamingOptions Class

Package:

com.azure.communication.callautomation.models

Maven Artifact:

com.azure:azure-communication-callautomation:1.6.1

• java.lang.Object
• • com.azure.communication.callautomation.models.MediaStreamingOptions

public final class MediaStreamingOptions

The MediaStreamingOptions model.

Constructor Summary

Constructor	Description
MediaStreamingOptions(MediaStreamingAudioChannel audioChannelType)	Creates a new instance of TranscriptionOptions with default transportType as WEBSOCKET.
MediaStreamingOptions(MediaStreamingAudioChannel audioChannelType, StreamingTransport transportType)	Creates a new instance of MediaStreamingOptions

Method Summary

Modifier and Type	Method and Description
MediaStreamingAudioChannel	getAudioChannelType() Get the audioChannelType property: Audio channel type to stream, eg.
AudioFormat	getAudioFormat() Get the audioFormat property: Specifies the audio format used for encoding, including sample rate and channel type.
MediaStreamingContentType	getContentType() Get the contentType property: Content type to stream, eg.
StreamingTransport	getTransportType() Get the transportType property: The type of tranport to be used for media streaming, eg.
String	getTransportUrl() Get the transportUrl property: Transport URL for media streaming.
Boolean	isEnableBidirectional() Get the enableBidirectional property: A value indicating whether bidirectional streaming is enabled.
Boolean	isEnableDtmfTones() Get the enableDtmfTones property: A value that indicates whether to stream the DTMF tones.
Boolean	isStartMediaStreaming() Get the startMediaStreaming property: A value indicating whether the media streaming should start immediately after the call is answered.
Boolean	isStartMediaStreamingEnabled() Get the startMediaStreaming property: Enables intermediate results for the transcribed speech.
MediaStreamingOptions	setAudioFormat(AudioFormat audioFormat) Set the audioFormat property: Specifies the audio format used for encoding, including sample rate and channel type.
MediaStreamingOptions	setContentType(MediaStreamingContentType contentType) Set the contentType property: The contentType property.
MediaStreamingOptions	setEnableBidirectional(Boolean enableBidirectional) Set the enableBidirectional property: A value indicating whether bidirectional streaming is enabled.
MediaStreamingOptions	setEnableDtmfTones(Boolean enableDtmfTones) Set the enableDtmfTones property: A value that indicates whether to stream the DTMF tones.
MediaStreamingOptions	setStartMediaStreaming(Boolean startMediaStreaming) Set the startMediaStreaming property: A value indicating whether the media streaming should start immediately after the call is answered.
MediaStreamingOptions	setTransportUrl(String transportUrl) Set the transportUrl property: Transport URL for media streaming.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MediaStreamingOptions

public MediaStreamingOptions(MediaStreamingAudioChannel audioChannelType)

Creates a new instance of TranscriptionOptions with default transportType as WEBSOCKET.

Parameters:

audioChannelType -

• Audio Channel Type

MediaStreamingOptions

public MediaStreamingOptions(MediaStreamingAudioChannel audioChannelType, StreamingTransport transportType)

Creates a new instance of MediaStreamingOptions

Parameters:

audioChannelType -

• Audio Channel Type

transportType -

• The type of transport to be used for media streaming, eg. Websocket

Method Details

getAudioChannelType

public MediaStreamingAudioChannel getAudioChannelType()

Get the audioChannelType property: Audio channel type to stream, eg. unmixed audio, mixed audio.

Returns:

the audioChannelType value.

getAudioFormat

public AudioFormat getAudioFormat()

Get the audioFormat property: Specifies the audio format used for encoding, including sample rate and channel type.

Returns:

the audioFormat value.

getContentType

public MediaStreamingContentType getContentType()

Get the contentType property: Content type to stream, eg. audio, audio/video.

Returns:

the contentType value.

getTransportType

public StreamingTransport getTransportType()

Get the transportType property: The type of tranport to be used for media streaming, eg. Websocket.

Returns:

the transportType value.

getTransportUrl

public String getTransportUrl()

Get the transportUrl property: Transport URL for media streaming.

Returns:

the transportUrl value.

isEnableBidirectional

public Boolean isEnableBidirectional()

Get the enableBidirectional property: A value indicating whether bidirectional streaming is enabled.

Returns:

the enableBidirectional value.

isEnableDtmfTones

public Boolean isEnableDtmfTones()

Get the enableDtmfTones property: A value that indicates whether to stream the DTMF tones.

Returns:

the enableDtmfTones value.

isStartMediaStreaming

public Boolean isStartMediaStreaming()

Get the startMediaStreaming property: A value indicating whether the media streaming should start immediately after the call is answered.

Returns:

the startMediaStreaming value.

isStartMediaStreamingEnabled

public Boolean isStartMediaStreamingEnabled()

Get the startMediaStreaming property: Enables intermediate results for the transcribed speech.

Returns:

the startMediaStreaming value.

setAudioFormat

public MediaStreamingOptions setAudioFormat(AudioFormat audioFormat)

Set the audioFormat property: Specifies the audio format used for encoding, including sample rate and channel type.

Parameters:

audioFormat - the audioFormat value to set.

Returns:

the MediaStreamingOptions object itself.

setContentType

public MediaStreamingOptions setContentType(MediaStreamingContentType contentType)

Set the contentType property: The contentType property.

Parameters:

contentType - the contentType value to set.

Returns:

the MediaStreamingOptions object itself.

setEnableBidirectional

public MediaStreamingOptions setEnableBidirectional(Boolean enableBidirectional)

Set the enableBidirectional property: A value indicating whether bidirectional streaming is enabled.

Parameters:

enableBidirectional - the enableBidirectional value to set.

Returns:

the MediaStreamingOptions object itself.

setEnableDtmfTones

public MediaStreamingOptions setEnableDtmfTones(Boolean enableDtmfTones)

Set the enableDtmfTones property: A value that indicates whether to stream the DTMF tones.

Parameters:

enableDtmfTones - the enableDtmfTones value to set.

Returns:

the MediaStreamingOptions object itself.

setStartMediaStreaming

public MediaStreamingOptions setStartMediaStreaming(Boolean startMediaStreaming)

Set the startMediaStreaming property: A value indicating whether the media streaming should start immediately after the call is answered.

Parameters:

startMediaStreaming - the startMediaStreaming value to set.

Returns:

the MediaStreamingOptions object itself.

setTransportUrl

public MediaStreamingOptions setTransportUrl(String transportUrl)

Set the transportUrl property: Transport URL for media streaming.

Parameters:

transportUrl - the transportUrl value to set.

Returns:

the MediaStreamingOptions object itself.