Package com.sinch.sdk.domains.voice.models.v2.destination

Interface StreamOptions

public interface StreamOptions

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	StreamOptions.Builder	Dedicated Builder
static class	StreamOptions.CodecEnum	Gets or Sets codec
static class	StreamOptions.SampleRateEnum	Gets or Sets sampleRate

Method Summary

Modifier and Type	Method	Description
static StreamOptions.Builder	builder()	Getting builder
StreamOptions.CodecEnum	getCodec()	Defines the audio codec/format used for the stream audio payload.
StreamOptions.SampleRateEnum	getSampleRate()	Defines the audio sampling rate (Hz) used for the stream.
Integer	getVersion()	Defines the version of the stream protocol.

Method Details

getVersion

Integer getVersion()

Defines the version of the stream protocol.

Returns:

version

getCodec

StreamOptions.CodecEnum getCodec()

Defines the audio codec/format used for the stream audio payload.

Currently, only PCM is supported (uncompressed raw audio). Use sampleRate to configure the sampling rate for the stream.

Returns:

codec

getSampleRate

StreamOptions.SampleRateEnum getSampleRate()

Defines the audio sampling rate (Hz) used for the stream.

For calls that traverse the PSTN, audio is typically sampled at 8 kHz, so using a higher value will not improve perceived quality. Higher sample rates can be useful for non-PSTN scenarios (for example, SIP/streaming paths), but will increase bandwidth usage and processing load.

Returns:

sampleRate

builder

static StreamOptions.Builder builder()

Getting builder

Returns:

New Builder instance