sora-android-sdk/jp.shiguredo.sora.sdk.channel.option/SoraMediaOption

SoraMediaOption

class SoraMediaOption

Sora への接続オプションを表すクラスです.

Constructors

SoraMediaOption

constructor()

Types

object Companion

SoraCameraConfig

data class SoraCameraConfig(val captureType: SoraVideoOption.CaptureType = SoraVideoOption.CaptureType.DEVICE_CAMERA, var width: Int = 640, var height: Int = 480, var frameRate: Int = 30, val frontFacingFirst: Boolean = true, val initialVideoHardMute: Boolean = false)

SDK 内部で CameraVideoCapturer を生成・管理するためのオプションです.

Properties

var audioBitrate: Int?

音声ビットレート.

var audioCodec: SoraAudioOption.Codec

音声コーデック.

var audioOption: SoraAudioOption

音声のオプション設定を指定します.

audioStreamingLanguageCode

var audioStreamingLanguageCode: String?

Sora の音声ストリーミング機能利用時に指定する言語コード.

degradationPreference

var degradationPreference: SoraVideoOption.DegradationPreference?

(リソースの逼迫により) 送信する映像の品質が維持できない場合の挙動. 映像エンコーダーがCPUやネットワーク帯域の制限に直面した際の振る舞いを制御します. null(未指定)の場合、WebRTC 側でデフォルトの挙動(BALANCED)が適用されます.

enableCpuOveruseDetection

var enableCpuOveruseDetection: Boolean

JavaScript API の "googCpuOveruseDetection" に相当する設定項目です.

hardwareVideoEncoderResolutionAdjustment

var hardwareVideoEncoderResolutionAdjustment: SoraVideoOption.ResolutionAdjustment

HW エンコーダー利用時の解像度を調整するパラメータ. HW エンコーダーに入力されるフレームの解像度が指定された数の倍数になるように調節します.

var proxy: SoraProxyOption

プロキシ.

var role: SoraChannelRole?

ロール.

softwareVideoEncoderOnly

var softwareVideoEncoderOnly: Boolean

映像エンコードにソフトウェアエンコーダーのみを使用します.

tcpCandidatePolicy

var tcpCandidatePolicy: PeerConnection.TcpCandidatePolicy

TcpCandidatePolicy を設定します.

var videoAv1Params: Any?

AV1 向け映像コーデックパラメーター.

var videoBitrate: Int?

映像ビットレート.

var videoCodec: SoraVideoOption.Codec

映像コーデック.

videoDecoderFactory

var videoDecoderFactory: VideoDecoderFactory?

利用する VideoDecoderFactory を指定します.

videoEncoderFactory

var videoEncoderFactory: VideoEncoderFactory?

利用する VideoEncoderFactory を指定します.

videoH264Params

var videoH264Params: Any?

H.264 向け映像コーデックパラメーター.

var videoVp9Params: Any?

VP9 向け映像コーデックパラメーター.

Functions

enableAudioDownstream

fun enableAudioDownstream()

音声の視聴を有効にします.

enableAudioUpstream

fun enableAudioUpstream()

音声の配信を有効にします.

enableLegacyStream

fun ~~enableLegacyStream~~()

レガシーストリームを有効にします.

enableMultistream

fun ~~enableMultistream~~()

マルチストリームを有効にします.

enableSimulcast

fun enableSimulcast(requestRid: SoraVideoOption.SimulcastRequestRid? = null)

fun ~~enableSimulcast~~(rid: SoraVideoOption.SimulcastRid?)

サイマルキャスト機能を有効にします.

enableSpotlight

fun enableSpotlight(option: SoraSpotlightOption, enableSimulcast: Boolean = true)

スポットライト機能を有効にします.

enableVideoDownstream

fun enableVideoDownstream(eglContext: EglBase.Context?)

映像の視聴を有効にします.

enableVideoUpstream

fun enableVideoUpstream(eglContext: EglBase.Context?, cameraConfig: SoraMediaOption.SoraCameraConfig)

映像の配信を有効にします (カメラキャプチャを SDK 内部で生成します).

fun enableVideoUpstream(capturer: VideoCapturer, eglContext: EglBase.Context?, cameraConfig: SoraMediaOption.SoraCameraConfig? = null)

映像の配信を有効にします.