Kakao i Connect Live::Kakao i Connect Live 2.0::API 레퍼런스::iOS::Config & Media Options

페이지 이동경로

Config

나 자신의 미디어인 로컬 미디어(Local Media) 설정과 오디오/비디오 리시버(Receiver)의 개수를 설정합니다. 리시버의 개수는 동시 구독이 가능한 스트림 수를 의미하며, 실제 필요한 수만큼만 생성하는 것을 권장합니다.
오디오 리시버 수는 정해져 있으며, 비디오 리시버의 수는 각 서비스의 상황에 맞춰 설정할 수 있습니다. 구독 요청 시 최대 리시버 수만큼 자동으로 리시버가 증가하며, 최대 리시버 이상의 구독을 요청할 경우 오류를 리턴합니다. 이 경우 기존 다른 스트림의 구독을 해제한 후 구독을 수행해야 리시버를 할당받을 수 있습니다.

Config 전체 목록
대분류 항목 설명
Config mediaOptions Local Media(로컬 미디어) 생성을 위한 옵션
videoReceiverInitialCount 초기 생성할 리시버의 개수를 설정
videoReceiverMaximumCount 최대 영상 리시버의 개수

mediaOptions

Local Media(로컬 미디어) 생성을 위한 옵션입니다.

mediaOptions Parameters
파라미터 타입 필수 여부 설명
mediaOptions LocalMediaOptions 선택 로컬 미디어 생성을 위한 옵션
- 자세한 설명은 LocalMediaOptions를 참고

videoReceiverInitialCount

초기 생성할 리시버의 개수를 설정합니다.

코드예제videoReceiverInitialCount Syntax

videoReceiverInitialCount ={초기 생성할 리시버의 개수}

videoReceiverInitialCount Parameters
파라미터 타입 필수 여부 설명
videoReceiverInitialCount Int 선택 초기 생성할 리시버의 수
- 기본값: 9

videoReceiverMaximumCount

최대 영상 리시버의 개수로, 동시에 표시할 화면의 수보다 높은 값으로 설정해야 합니다.

코드예제videoReceiverMaximumCount Syntax

config.videoReceiverMaximumCount ={최대 영상 리시버의 개수}

videoReceiverMaximumCount Parameters
파라미터 타입 필수 여부 설명
videoReceiverMaximumCount Int 선택 최대 영상 리시버의 개수
- 기본값: 20

LocalMedia Options

비디오 소스 선택, 오디오 타입 선택 등 로컬 미디어의 옵션을 설정할 수 있습니다.

LocalMedia Options 전체 목록
대분류 항목 설명
LocalMediaOptions source 로컬 미디어의 비디오 소스를 선택
hasAudio 로컬 미디어가 오디오 스트림의 포함 여부를 설정
hasVideo 로컬 미디어가 비디오 스트림의 포함 여부를 설정
audio 로컬 미디어 시작 시 오디오의 활성화 여부를 선택
video 로컬 미디어 시작 시 비디오의 활성화 여부를 선택
videoExtraValue 비디오 스트림 생성 시 비디오 스트림의 extraValue에 할당할 문자열
audioExtraValue 오디오 스트림 생성 시 오디오 스트림의 extraValue에 할당할 문자열
rotationType 카메라가 회전하는 방식을 선택
position 비디오 스트리밍 시 사용할 카메라 위치를 선택
isMirror 카메라 영상의 좌우 반전 여부를 설정
audioType 앱에서 사용하는 오디오 타입을 선택
autoGain 앱에서 마이크 입력의 자동 레벨 조정 기능의 사용 여부를 선택

source

로컬 미디어의 비디오 소스를 선택합니다.

코드예제source Syntax

mediaOptions.source =.{camera | bypass | file}

source Parameters
파라미터 타입 필수 여부 설명
mediaOptions.source CapturerType 선택 비디오 소스 유형
camera(기본값): 카메라
bypass: 데이터 샘플 버퍼(화면 공유)
file: 시뮬레이터인 경우로, 프로젝트내에 포함된 mov 파일을 fileName에 설정 필요

hasAudio

로컬 미디어가 오디오 스트림의 포함 여부를 설정합니다. false로 설정 시, 로컬 미디어가 생성될 때 오디오 장치 및 설정을 수행하지 않습니다.

코드예제hasAudio Syntax

mediaOptions.hasAudio ={true | false}

hasAudio Parameters
파라미터 타입 필수 여부 설명
mediaOptions.hasAudio Boolean 선택 오디오 스트림의 포함 여부
true(기본값): 오디오 장치 및 설정을 수행
false: 오디오 장치 및 설정을 하지 않음

hasVideo

로컬 미디어가 비디오 스트림의 포함 여부를 설정합니다. false로 설정 시, 로컬 미디어를 생성하면 비디오 장치 및 설정은 이루어지지 않습니다.

코드예제hasVideo Syntax

mediaOptions.hasVideo ={true | false}

hasAudio Parameters
파라미터 타입 필수 여부 설명
mediaOptions.hasVideo Boolean 선택 비디오 스트림의 포함 여부
true(기본값): 비디오 장치 및 설정을 수행
false: 비디오 장치 및 설정을 하지 않음

audio

로컬 미디어가 오디오를 포함하고 있을 때, 로컬 미디어 시작 시 오디오의 활성화 여부를 선택합니다. false로 설정 시, 연결 이후에 오디오를 바로 활성화하지 않습니다.

코드예제audio Syntax

mediaOptions.audio={true | false}

audio Parameters
파라미터 타입 필수 여부 설명
mediaOptions.audio Boolean 선택 로컬 미디어가 오디오를 포함하고 있을 때, 오디오의 활성화 여부
true(기본값): 오디오 활성화
false: 오디오 활성화하지 않음

video

로컬 미디어가 비디오를 포함하고 있을 때, 로컬 미디어 시작 시 비디오의 활성화 여부를 선택합니다. false로 설정 시, 로컬 미디어를 연결한 이후 비디오를 바로 활성화하지 않습니다.

코드예제video Syntax

mediaOptions.video ={true | false}

video Parameters
파라미터 타입 필수 여부 설명
mediaOptions.video Boolean 선택 로컬 미디어가 비디오를 포함하고 있을 때, 비디오의 활성화 여부
true(기본값): 비디오 활성화
false: 비디오 활성화하지 않음

videoExtraValue

비디오 스트림 생성 시 비디오 스트림의 extraValue에 할당할 문자열입니다. 고객 서비스에 따라 원하는 문자열을 넣어 사용할 수 있습니다.

코드예제videoExtraValue Syntax

mediaOptions.videoExtraValue ={비디오 스트림의 extraValue에 할당할 문자열}

videoExtraValue Parameters
파라미터 타입 필수 여부 설명
mediaOptions.videoExtraValue String 선택 비디오 스트림의 extraValue에 할당할 문자열

audioExtraValue

오디오 스트림 생성 시 오디오 스트림의 extraValue에 할당할 문자열입니다. 고객 서비스에 따라 원하는 문자열을 넣어 사용할 수 있습니다.

코드예제audioExtraValue Syntax

mediaOptions.audioExtraValue ={오디오 스트림의 extraValue에 할당할 문자열}

audioExtraValue Parameters
파라미터 타입 필수 여부 설명
mediaOptions.audioExtraValue String 선택 오디오 스트림의 extraValue에 할당할 문자열

rotationType

카메라가 회전하는 방식을 선택합니다.

코드예제rotationType Syntax

mediaOptions.rotationType =.{카메라 회전 방식}

rotationType Parameters
파라미터 타입 필수 여부 설명
mediaOptions.rotationType CameraRotationType 선택 카메라 회전 방식
notAvailable(기본값): 카메라를 회전하지 않음
deviceOrientation: 디바이스 회전에 따라 카메라를 회전(앱은 고정되어 있어도 카메라를 회전)
appOrientation: 앱 회전에 따라 카메라를 회전

position

비디오 스트리밍 시 사용할 카메라 위치를 선택합니다.

코드예제position Syntax

mediaOptions.positon =.{front | back}

position Parameters
파라미터 타입 필수 여부 설명
mediaOptions.position AVCaptureDevice.Position 선택 카메라 위치
front(기본값): 전면 카메라
back: 후면 카메라

isMirror

카메라 영상의 좌우 반전 여부를 설정합니다.

코드예제isMirror Syntax

mediaOptions.isMirror = {true | false}

isMirror Parameters
파라미터 타입 필수 여부 설명
mediaOptions.isMirror Boolean 선택 카메라 영상의 좌우 반전 여부
true: 비디오 좌우 반전
false(기본값): 비디오 좌우 반전하지 않음

audioType

앱에서 사용하는 오디오 타입을 선택합니다. 이 설정은 전역 설정이며, SDK 실행 시 설정되면 실행 중간에 변경할 수 없습니다.

코드예제audioType Syntax

LocalMediaOptions.audioType =.{voice | music}

audioType Parameters
파라미터 타입 필수 여부 설명
LocalmediaOptions.audioType AudioProcessingType 필수 오디오 타입
voice(기본값): 음성모드, 에코 캔슬레이션 활성화
music: 음악모드

autoGain

앱에서 마이크 입력의 자동 레벨 조정 기능의 사용 여부를 선택합니다. 이 설정은 전역 설정이며, SDK 실행 시 설정되면 실행 중간에 변경할 수 없습니다.

코드예제autoGain Syntax

LocalMediaOptions.autoGain ={true | false}

autoGain Parameters
파라미터 타입 필수 여부 설명
LocalmediaOptions.autoGain Boolean 필수 자동 오디오 입력 레벨 조정
true: 자동 오디오 입력 레벨 조정을 활성화
false(기본값): 자동 오디오 입력 레벨 조정을 비활성화
이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

더 자세한 의견은 documentation@kakaoenterprise.com 으로 제보해주세요.