LocalAudio
LocalAudio 클래스는 LocalMedia의 audio 속성에 해당되는 객체입니다. LocalAudio클래스는 Property와 Method로 구성됩니다.
표LocalAudio 클래스 전체 목록클래스 | 구분 | 항목 | 설명 |
---|---|---|---|
LocalAudio | Property | streamId | 고유 아이디 반환 |
isAlwaysOn | alwaysOn 여부를 반환 | ||
Method | getMediaStreamTrack() | Local Audio의 미디어 스트림 트랙 반환 | |
getMediaStream() | 미디어 스트림(오디오) 반환 | ||
getStreamId() | 미디어의 고유 아이디인 streamId 반환 | ||
setExtraValue() | 서비스에서 필요한 값을 extraValue로 설정 | ||
getExtraValue() | 서비스에서 설정한 extraValue 반환 | ||
setEnabled() | 미디어 트랙의 상태 활성화 또는 비활성화 | ||
true : 미디어 스트림 트랙 활성화 시 미디어 출처 스트림의 렌더링 허용 |
|||
false : 미디어 스트림 트랙이 비 활성되어 음소거로 처리됨 |
|||
stop() | 미디어 트랙 중지 | ||
setAlwaysOn() | 필요시 alwaysOn 기능을 설정하여 로컬 참여자의 오디오를 항상 재생하도록 설정 |
Property
LocalAudio 클래스의 프로퍼티는 다음과 같습니다.
표LocalAudio 프로퍼티 목록Property | 타입 | 설명 |
---|---|---|
streamId | Number | 고유 아이디 반환 |
isAlwaysOn | Boolean | alwaysOn 여부 반환 |
Method
LocalAudio 클래스의 메서드는 다음과 같습니다.
getMediaStreamTrack()
Local Audio의 미디어 스트림 트랙을 반환합니다. 미디어 스트림 트랙은 스트림 내의 단일 미디어 트랙으로, 오디오 트랙을 의미합니다.
코드예제getMediaStreamTrack() Syntax
const track = localAudio.getMediaStreamTrack();
반환 | 타입 | 설명 |
---|---|---|
MediaStreamTrack | MediaStreamTrack | 미디어 스트림 트랙(오디오) |
getMediaStream()
미디어 스트림(오디오)을 반환합니다.
코드예제getMediaStream() Syntax
const stream = localAudio.getMediaStream();
반환 | 타입 | 설명 |
---|---|---|
MediaStream | MediaStream | 미디어 스트림(오디오) |
getStreamId()
미디어의 고유 아이디인 streamId를 반환합니다.
코드예제getStreamId() Syntax
const streamId = localAudio.getStreamId();
반환 | 타입 | 설명 |
---|---|---|
streamId | Number | 미디어 고유 아이디 |
setExtraValue()
서비스에서 필요한 값을 extraValue로 설정합니다. 설정된 extraValue는 다른 참여자들과 공유됩니다.
코드예제setExtraValue() Syntax
localAudio.setExtraValue('{extraValue}');
파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
extraValue | String | 필수 |
저장이 필요한 문자열 |
getExtraValue()
서비스에서 설정한 extraValue를 반환합니다.
코드예제getExtraValue() Syntax
const extraValue = localAudio.getExtraValue();
반환 | 타입 | 설명 |
---|---|---|
extra value | String | 서비스에서 설정한 값 |
setEnabled()
미디어 트랙의 상태를 활성화 또는 비활성화합니다. 미디어 트랙 상태를 true
로 설정하여 미디어 스트림 트랙을 활성화하면, 미디어 출처 스트림의 렌더링을 허용합니다. 반대로, false
로 설정 시 미디어 스트림 트랙이 비활성화되어 음소거로 처리됩니다.
코드예제setEnabled() Syntax
await localAudio.setEnabled({enabled});
반환 | 구분 | 타입 | 설명 |
---|---|---|---|
promise | 성공 | N/A | 성공 시 아무것도 반환하지 않음 |
실패 | Promise<ServerError> |
호출 실패 시 반환 - 상세 에러 정보는 Error code 문서 참고 |
stop()
미디어 트랙(오디오)을 중지합니다.
코드예제stop() Syntax
localAudio.stop();
setAlwaysOn()
필요 시, alwaysOn 기능을 설정하여 로컬 참여자의 오디오를 항상 재생하도록 설정할 수 있습니다.
- SDK에서는 기본적으로 오디오 송출 시, Room에서 오디오 레벨이 가장 큰 4명의 오디오를 내보냅니다. alwaysOn은 만약 4명의 오디오가 있을 경우 오디오 레벨에 상관 없이 로컬 참여자의 오디오를 항상 내보내고 싶을 때 설정하는 기능입니다.
코드예제setAlwaysOn() Syntax
await localVideo.setAlwaysOn({enabled});
파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
enabled | Boolean | 필수 |
alwaysOn 설정 |
true : 활성화 (로컬 참여자의 오디오 항상 재생)
|
|||
false : 비활성화
|
반환 | 구분 | 타입 | 설명 |
---|---|---|---|
promise | 성공 | N/A | 성공 시 아무것도 반환하지 않음 |
실패 | Promise<ServerError> |
호출 실패 시 반환 - 상세 에러 정보는 Error code 문서 참고 |