chrome.audio

설명

chrome.audio API는 사용자가 시스템에 연결된 오디오 기기에 관한 정보를 얻고 제어할 수 있도록 제공됩니다. 이 API는 현재 ChromeOS용 키오스크 모드에서만 사용할 수 있습니다.

권한

audio

지원 대상

Chrome 59 이상 ChromeOS만 해당

유형

AudioDeviceInfo

속성

  • deviceName

    string

    기기 이름.

  • deviceType

    DeviceType

    기기 유형입니다.

  • displayName

    string

    사용자에게 친숙한 이름입니다 (예: 'USB 마이크').

  • id

    string

    오디오 기기의 고유 식별자입니다.

  • isActive

    boolean

    현재 활성 기기인 경우 참입니다.

  • 레벨

    숫자

    기기의 사운드 수준, 출력용 볼륨, 입력용 게인입니다.

  • stableDeviceId

    문자열 선택사항

    안정적인/유지된 기기 ID 문자열입니다(있는 경우).

  • streamType

    StreamType

    이 기기와 연결된 스트림 유형입니다.

DeviceFilter

속성

  • isActive

    부울 선택사항

    설정하면 활성 상태가 이 값과 일치하는 오디오 기기만 필터를 충족합니다.

  • streamTypes

    StreamType[] 선택사항

    설정하면 이 목록에 스트림 유형이 포함된 오디오 기기만 필터를 충족합니다.

DeviceIdLists

속성

  • 입력

    string[] 선택사항

    ID로 지정된 입력 기기 목록입니다.

    입력 기기가 영향을 받지 않아야 함을 나타내려면 이 속성을 설정하지 않은 상태로 둡니다.

  • 출력

    string[] 선택사항

    ID로 지정된 출력 기기 목록입니다.

    출력 장치가 영향을 받지 않아야 함을 나타내려면 이 속성을 설정하지 않은 상태로 둡니다.

DeviceProperties

속성

  • 레벨

    number 선택사항

    오디오 기기에서 원하는 사운드 수준입니다. 기본적으로 기기의 현재 사운드 레벨로 설정됩니다.

    오디오 입력 장치와 함께 사용되는 경우 오디오 장치 게인을 나타냅니다.

    오디오 출력 장치와 함께 사용되는 경우, 오디오 장치 볼륨을 나타냅니다.

DeviceType

사용 가능한 오디오 기기 유형

열거형

"USB"

"HOTWORD"

LevelChangedEvent

속성

  • deviceId

    string

    소리 수준이 변경된 기기의 ID입니다.

  • 레벨

    숫자

    기기의 새로운 사운드 수준입니다.

MuteChangedEvent

속성

  • isMuted

    boolean

    현재 스트림의 음소거 여부입니다.

  • streamType

    StreamType

    음소거 값이 변경된 스트림의 유형입니다. 업데이트된 음소거 값은 이 스트림 유형의 모든 기기에 적용됩니다.

StreamType

오디오 기기가 제공하는 스트림의 유형입니다.

열거형

방법

getDevices()

프로미스 
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
)

filter를 기준으로 필터링된 오디오 기기 목록을 가져옵니다.

매개변수

  • filter

    DeviceFilter 선택사항

    반환된 오디오 기기 목록을 필터링할 기기 속성입니다. 필터가 설정되지 않거나 {}로 설정되면 반환된 기기 목록에 사용 가능한 모든 오디오 기기가 포함됩니다.

  • 콜백

    함수 선택사항

    callback 매개변수는 다음과 같습니다. 

    (devices: AudioDeviceInfo[])=>void

반환 값

  • Promise<AudioDeviceInfo[]>

    Chrome 116 이상

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

getMute()

프로미스 
chrome.audio.getMute(
  streamType: StreamType,
  callback?: function,
)

지정된 스트림 유형의 시스템 전체 음소거 상태를 가져옵니다.

매개변수

  • streamType

    StreamType

    음소거 상태를 가져와야 하는 스트림 유형입니다.

  • 콜백

    함수 선택사항

    callback 매개변수는 다음과 같습니다. 

    (value: boolean)=>void

    • 값

      boolean

반환 값

  • Promise<boolean>

    Chrome 116 이상

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

setActiveDevices()

프로미스 
chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
  callback?: function,
)

활성 입력 및/또는 출력 장치 목록을 설정합니다.

매개변수

  • 활성화해야 하는 기기의 ID를 지정합니다. 입력 또는 출력 목록이 설정되지 않은 경우 해당 카테고리의 기기는 영향을 받지 않습니다.

    존재하지 않는 기기 ID를 전달하면 오류가 발생합니다.

  • 콜백

    함수 선택사항

    callback 매개변수는 다음과 같습니다. 

    ()=>void

반환 값

  • Promise<void>

    Chrome 116 이상

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

setMute()

프로미스 
chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
  callback?: function,
)

스트림 유형의 음소거 상태를 설정합니다. 음소거 상태는 지정된 오디오 스트림 유형의 모든 오디오 기기에 적용됩니다.

매개변수

  • streamType

    StreamType

    음소거 상태를 설정해야 하는 스트림 유형입니다.

  • isMuted

    boolean

    새 음소거 값

  • 콜백

    함수 선택사항

    callback 매개변수는 다음과 같습니다. 

    ()=>void

반환 값

  • Promise<void>

    Chrome 116 이상

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

setProperties()

프로미스 
chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
  callback?: function,
)

입력 또는 출력 장치의 속성을 설정합니다.

매개변수

  • id

    string

  • 콜백

    함수 선택사항

    callback 매개변수는 다음과 같습니다. 

    ()=>void

반환 값

  • Promise<void>

    Chrome 116 이상

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

이벤트

onDeviceListChanged

chrome.audio.onDeviceListChanged.addListener(
  callback: function,
)

오디오 기기가 변경되거나 새 기기가 추가되거나 기존 기기가 삭제되면 시작됩니다.

매개변수

onLevelChanged

chrome.audio.onLevelChanged.addListener(
  callback: function,
)

활성 오디오 기기의 소리 수준이 변경되면 실행됩니다.

매개변수

onMuteChanged

chrome.audio.onMuteChanged.addListener(
  callback: function,
)

오디오 입력 또는 출력의 음소거 상태가 변경되면 시작됩니다. 음소거 상태는 시스템 전체이며 새로운 값은 지정된 스트림 유형의 모든 오디오 기기에 적용됩니다.

매개변수