Package co.daily.settings

Types

AudioMediaTrackSettings

@Serializable

data class AudioMediaTrackSettings

Settings to define and select a audio media input device.

AudioMediaTrackSettingsUpdate

@Serializable

data class AudioMediaTrackSettingsUpdate(deviceId: Update<Device>?) : Update<AudioMediaTrackSettingsUpdate>

Settings to select and configure an audio media input device.

AudioSendQuality

@Serializable

enum AudioSendQuality : Enum<AudioSendQuality> , Update<AudioSendQuality>

AudioSendQualityInterface

interface AudioSendQualityInterface

AudioSendSettings

@Serializable

data class AudioSendSettings

Custom configuration for an outbound audio track, like microphone audio.

AudioSendSettingsUpdate

@Serializable

data class AudioSendSettingsUpdate(channelConfig: Update<ChannelConfigUpdate>?, bitRate: Update<BitRate>?) : Update<AudioSendSettingsUpdate>

Custom configuration for an outbound audio track, like microphone audio.

BitRate

@Serializable

data class BitRate(bitRate: Int?) : Update<BitRate>

CameraInputSettings

@Serializable

data class CameraInputSettings

Input settings specifically for the camera input.

CameraInputSettingsUpdate

@Serializable

data class CameraInputSettingsUpdate(isEnabled: Update<StateBoolean>?, settings: Update<VideoMediaTrackSettingsUpdate>?) : Update<CameraInputSettingsUpdate> , StateBoolean

Input settings specifically for the camera input.

CameraPublishingSettings

@Serializable

data class CameraPublishingSettings

Configuration for publishing a camera input.

CameraPublishingSettingsUpdate

@Serializable

data class CameraPublishingSettingsUpdate(isPublishing: Update<StateBoolean>?, sendSettings: Update<VideoSendSettingsUpdate>?) : Update<CameraPublishingSettingsUpdate>

Configuration for publishing a camera input.

ChannelConfig

@Serializable

enum ChannelConfig : Enum<ChannelConfig>

ChannelConfigUpdate

@Serializable

enum ChannelConfigUpdate : Enum<ChannelConfigUpdate> , Update<ChannelConfigUpdate>

ClientSettings

@Serializable

data class ClientSettings

Call client settings currently being used to fully configure media inputs and track publishing on CallClient.join.

ClientSettingsUpdate

@Serializable

data class ClientSettingsUpdate(inputSettings: Update<InputSettingsUpdate>?, publishingSettings: Update<PublishingSettingsUpdate>?)

Call client settings used to configure media inputs and track publishing on CallClient.join, as a convenience.

CodecName

@Serializable

enum CodecName : Enum<CodecName>

CodecNameUpdate

@Serializable

enum CodecNameUpdate : Enum<CodecNameUpdate> , Update<CodecNameUpdate>

CustomAudioTrackPublishingSettings

@Serializable

data class CustomAudioTrackPublishingSettings

Configuration for publishing a custom audio track.

CustomAudioTrackPublishingSettingsUpdate

@Serializable

data class CustomAudioTrackPublishingSettingsUpdate(isPublishing: Update<StateBoolean>?, sendSettings: Update<AudioSendSettingsUpdate>?) : Update<CustomAudioTrackPublishingSettingsUpdate>

Configuration for publishing a custom audio track.

CustomMediaTrackSettings

@Serializable

data class CustomMediaTrackSettings(customTrack: MediaStreamTrack)

CustomTrackInputSettings

@Serializable

data class CustomTrackInputSettings

Input settings for a custom track

CustomVideoTrackPublishingSettings

@Serializable

data class CustomVideoTrackPublishingSettings

Configuration for publishing a custom video track.

CustomVideoTrackPublishingSettingsUpdate

@Serializable

data class CustomVideoTrackPublishingSettingsUpdate(isPublishing: Update<StateBoolean>?, sendSettings: Update<VideoSendSettingsUpdate>?) : Update<CustomVideoTrackPublishingSettingsUpdate>

Configuration for publishing a custom video track.

Device

@Serializable

data class Device(id: String?) : Update<Device>

Disable

@Serializable

class Disable<T> : Update<T> , StateBoolean

Use 'Disable()' to disable a setting

Enable

@Serializable

class Enable<T> : Update<T> , StateBoolean

Use 'Enable()' to enable a setting

FacingMode

@Serializable

enum FacingMode : Enum<FacingMode>

FacingModeUpdate

@Serializable

enum FacingModeUpdate : Enum<FacingModeUpdate> , Update<FacingModeUpdate>

FrameRate

@Serializable

data class FrameRate(frameRate: Int?) : Update<FrameRate>

FromDefaults

@Serializable

class FromDefaults<T> : Update<T>

Use 'FromDefaults()' when updating a setting which should be reverted to its default value.

Height

@Serializable

data class Height(height: Int?) : Update<Height>

InputSettings

@Serializable

data class InputSettings

Configuration for input settings

InputSettingsUpdate

@Serializable

data class InputSettingsUpdate(camera: Update<CameraInputSettingsUpdate>?, microphone: Update<MicrophoneInputSettingsUpdate>?, screenVideo: Update<ScreenVideoInputSettingsUpdate>?) : Update<InputSettingsUpdate>

Settings to update the call's inputs to.

MicrophoneInputSettings

@Serializable

data class MicrophoneInputSettings

Input settings specifically for the microphone input.

MicrophoneInputSettingsUpdate

@Serializable

data class MicrophoneInputSettingsUpdate(isEnabled: Update<StateBoolean>?, settings: Update<AudioMediaTrackSettingsUpdate>?) : Update<MicrophoneInputSettingsUpdate> , StateBoolean

Input settings specifically for the microphone input.

MicrophonePublishingSettings

@Serializable

data class MicrophonePublishingSettings

Configuration for publishing a microphone input.

MicrophonePublishingSettingsUpdate

@Serializable

data class MicrophonePublishingSettingsUpdate(isPublishing: Update<StateBoolean>?, sendSettings: Update<AudioSendSettingsUpdate>?) : Update<MicrophonePublishingSettingsUpdate>

Configuration for publishing a microphone input.

PublishingSettings

@Serializable

data class PublishingSettings

Configuration for the call's publishing settings

PublishingSettingsUpdate

@Serializable

data class PublishingSettingsUpdate(camera: Update<CameraPublishingSettingsUpdate>?, microphone: Update<MicrophonePublishingSettingsUpdate>?, customVideo: Map<CustomTrackName, CustomVideoTrackPublishingSettingsUpdate>?, customAudio: Map<CustomTrackName, CustomAudioTrackPublishingSettingsUpdate>?, screenVideo: Update<ScreenVideoPublishingSettingsUpdate>?) : Update<PublishingSettingsUpdate>

Configuration for publishing media inputs.

Scale

@Serializable

data class Scale(scale: Float?) : Update<Scale>

ScreenVideoInputSettings

@Serializable

data class ScreenVideoInputSettings

Input settings specifically for the screenVideo input.

ScreenVideoInputSettingsUpdate

@Serializable

data class ScreenVideoInputSettingsUpdate(isEnabled: Update<StateBoolean>?) : Update<ScreenVideoInputSettingsUpdate> , StateBoolean

Input settings specifically for the screenVideo input.

ScreenVideoPublishingSettings

@Serializable

data class ScreenVideoPublishingSettings

Configuration for publishing a screenVideo input.

ScreenVideoPublishingSettingsUpdate

@Serializable

data class ScreenVideoPublishingSettingsUpdate(isPublishing: Update<StateBoolean>?, sendSettings: Update<VideoSendSettingsUpdate>?) : Update<ScreenVideoPublishingSettingsUpdate>

Configuration for publishing a screenVideo input.

StateBoolean

interface StateBoolean

Torch

@Serializable

data class Torch(torch: Boolean?) : Update<Torch>

Update

@Serializable(with = UpdateSerializer::class)

interface Update<out T>

VideoEncodingSettings

@Serializable

data class VideoEncodingSettings

VideoEncodingSettingsUpdate

@Serializable

data class VideoEncodingSettingsUpdate(maxBitrate: Update<BitRate>?, maxFramerate: Update<FrameRate>?, scaleResolutionDownBy: Update<Scale>?) : Update<VideoEncodingSettingsUpdate>

VideoEncodingsSettingsUpdate

@Serializable

data class VideoEncodingsSettingsUpdate(settings: Map<VideoMaxQualityUpdate, VideoEncodingSettingsUpdate>) : Update<VideoEncodingsSettingsUpdate>

VideoMaxQualityUpdate

@Serializable

enum VideoMaxQualityUpdate : Enum<VideoMaxQualityUpdate> , Update<VideoMaxQualityUpdate>

VideoMediaTrackSettings

@Serializable

data class VideoMediaTrackSettings

Settings used to select and configure a video input device.

VideoMediaTrackSettingsUpdate

@Serializable

data class VideoMediaTrackSettingsUpdate(deviceId: Update<Device>?, width: Update<Width>?, height: Update<Height>?, frameRate: Update<FrameRate>?, facingMode: Update<FacingModeUpdate>?, torch: Update<Torch>?, zoom: Update<ZoomRatio>?, processor: Update<VideoProcessor>?) : Update<VideoMediaTrackSettingsUpdate>

Settings used to select and configure a video input device.

VideoProcessor

@Serializable

sealed class VideoProcessor : Update<VideoProcessor> , CustomJsonSerialize

VideoSendSettings

@Serializable

data class VideoSendSettings

Configuration for an outbound video track, like camera video.

VideoSendSettingsMaxQuality

@Serializable

enum VideoSendSettingsMaxQuality : Enum<VideoSendSettingsMaxQuality>

VideoSendSettingsUpdate

@Serializable

data class VideoSendSettingsUpdate(maxQuality: Update<VideoMaxQualityUpdate>?, encodings: Update<VideoEncodingsSettingsUpdate>?, preferredCodec: Update<CodecNameUpdate>?, allowAdaptiveLayers: Update<StateBoolean>?) : Update<VideoSendSettingsUpdate>

Configuration for an outbound video track, like camera video.

Width

@Serializable

data class Width(width: Int?) : Update<Width>

ZoomRatio

@Serializable

data class ZoomRatio(zoomRatio: Double?) : Update<ZoomRatio>