daily-android/co.daily.settings

Package-level declarations

Types

AudioMediaTrackSettings

@Serializable

data class AudioMediaTrackSettings

Settings to define and select a audio media input device.

AudioMediaTrackSettingsUpdate

@Serializable

data class AudioMediaTrackSettingsUpdate(val deviceId: Update<Device>? = null) : 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(val channelConfig: Update<ChannelConfigUpdate>? = null, val bitRate: Update<BitRate>? = null) : Update<AudioSendSettingsUpdate>

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

BitRate

@Serializable

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

CameraInputSettings

@Serializable

data class CameraInputSettings

Input settings specifically for the camera input.

CameraInputSettingsUpdate

@Serializable

data class CameraInputSettingsUpdate(val isEnabled: Update<StateBoolean>? = null, val settings: Update<VideoMediaTrackSettingsUpdate>? = null) : 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(val isPublishing: Update<StateBoolean>? = null, val sendSettings: Update<VideoSendSettingsUpdate>? = null) : 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(val inputSettings: Update<InputSettingsUpdate>? = null, val publishingSettings: Update<PublishingSettingsUpdate>? = null)

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(val isPublishing: Update<StateBoolean>? = null, val sendSettings: Update<AudioSendSettingsUpdate>? = null) : Update<CustomAudioTrackPublishingSettingsUpdate>

Configuration for publishing a custom audio track.

CustomMediaTrackSettings

@Serializable

data class CustomMediaTrackSettings(val 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(val isPublishing: Update<StateBoolean>? = null, val sendSettings: Update<VideoSendSettingsUpdate>? = null) : Update<CustomVideoTrackPublishingSettingsUpdate>

Configuration for publishing a custom video track.

Device

@Serializable

data class Device(val id: String? = null) : 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(var frameRate: Int? = null) : 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(var height: Int? = null) : Update<Height>

InputSettings

@Serializable

data class InputSettings

Configuration for input settings

InputSettingsUpdate

@Serializable

data class InputSettingsUpdate(val camera: Update<CameraInputSettingsUpdate>? = null, val microphone: Update<MicrophoneInputSettingsUpdate>? = null, val screenVideo: Update<ScreenVideoInputSettingsUpdate>? = null) : 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(val isEnabled: Update<StateBoolean>? = null, val settings: Update<AudioMediaTrackSettingsUpdate>? = null) : 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(val isPublishing: Update<StateBoolean>? = null, val sendSettings: Update<AudioSendSettingsUpdate>? = null) : 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(val camera: Update<CameraPublishingSettingsUpdate>? = null, val microphone: Update<MicrophonePublishingSettingsUpdate>? = null, val customVideo: Map<CustomTrackName, CustomVideoTrackPublishingSettingsUpdate>? = null, val customAudio: Map<CustomTrackName, CustomAudioTrackPublishingSettingsUpdate>? = null, val screenVideo: Update<ScreenVideoPublishingSettingsUpdate>? = null) : Update<PublishingSettingsUpdate>

Configuration for publishing media inputs.

Scale

@Serializable

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

ScreenVideoInputSettings

@Serializable

data class ScreenVideoInputSettings

Input settings specifically for the screenVideo input.

ScreenVideoInputSettingsUpdate

@Serializable

data class ScreenVideoInputSettingsUpdate(val isEnabled: Update<StateBoolean>? = null) : 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(val isPublishing: Update<StateBoolean>? = null, val sendSettings: Update<VideoSendSettingsUpdate>? = null) : Update<ScreenVideoPublishingSettingsUpdate>

Configuration for publishing a screenVideo input.

StateBoolean

interface StateBoolean

Torch

@Serializable

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

Update

@Serializable(with = UpdateSerializer::class)

interface Update<out T>

VideoEncodingSettings

@Serializable

data class VideoEncodingSettings

VideoEncodingSettingsUpdate

@Serializable

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

VideoEncodingsSettingsUpdate

@Serializable

data class VideoEncodingsSettingsUpdate(val 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(val deviceId: Update<Device>? = null, val width: Update<Width>? = null, val height: Update<Height>? = null, val frameRate: Update<FrameRate>? = null, val facingMode: Update<FacingModeUpdate>? = null, val torch: Update<Torch>? = null, val zoom: Update<ZoomRatio>? = null, val processor: Update<VideoProcessor>? = null) : 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(val maxQuality: Update<VideoMaxQualityUpdate>? = null, val encodings: Update<VideoEncodingsSettingsUpdate>? = null, val preferredCodec: Update<CodecNameUpdate>? = null, val allowAdaptiveLayers: Update<StateBoolean>? = null) : Update<VideoSendSettingsUpdate>

Configuration for an outbound video track, like camera video.

Width

@Serializable

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

ZoomRatio

@Serializable

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