디바이스 포털 API 참조

  • 아티클

Windows 디바이스 포털의 모든 항목은 데이터에 액세스하고 프로그래밍 방식으로 디바이스를 제어하는 데 사용할 수 있는 REST API를 기반으로 빌드됩니다.

앱 배포

/api/app/packagemanager/package(DELETE)

앱을 제거합니다.

매개 변수

  • package: 제거할 패키지의 파일 이름입니다.

/api/app/packagemanager/package(POST)

앱을 설치합니다.

매개 변수

  • package: 설치할 패키지의 파일 이름입니다.

Payload

  • http 본문을 준수하는 다중 파트

/api/app/packagemanager/packages(GET)

시스템에 설치된 앱 목록을 검색합니다. 세부 정보를 포함합니다.

데이터 반환

  • 세부 정보가 포함된 설치된 패키지 목록

/api/app/packagemanager/state(GET)

진행 중인 앱 설치의 상태 가져옵니다.

덤프 컬렉션

/api/debug/dump/usermode/crashcontrol(DELETE)

테스트용으로 로드된 앱에 대해 크래시 덤프 수집을 사용하지 않도록 설정합니다.

매개 변수

  • packageFullName: 패키지 이름

/api/debug/dump/usermode/crashcontrol(GET)

테스트용으로 로드된 앱 크래시 덤프 컬렉션에 대한 설정을 가져옵니다.

매개 변수

  • packageFullName: 패키지 이름

/api/debug/dump/usermode/crashcontrol(POST)

테스트용으로 로드된 앱에 대한 덤프 제어 설정을 사용하도록 설정하고 설정합니다.

매개 변수

  • packageFullName: 패키지 이름

/api/debug/dump/usermode/crashdump(DELETE)

테스트용으로 로드된 앱에 대한 크래시 덤프를 삭제합니다.

매개 변수

  • packageFullName: 패키지 이름
  • fileName: 덤프 파일 이름

/api/debug/dump/usermode/crashdump(GET)

테스트용으로 로드된 앱에 대한 크래시 덤프를 검색합니다.

매개 변수

  • packageFullName: 패키지 이름
  • fileName: 덤프 파일 이름

데이터 반환

  • 덤프 파일. WinDbg 또는 Visual Studio를 사용하여 검사합니다.

/api/debug/dump/usermode/dumps(GET)

테스트용으로 로드된 앱에 대한 모든 크래시 덤프 목록을 반환합니다.

데이터 반환

  • 사이드 로드된 앱당 크래시 덤프 목록

ETW

/api/etw/providers(GET)

등록된 공급자를 열거합니다.

데이터 반환

  • 공급자 목록, 이름 및 GUID

/api/etw/session/realtime(GET/WebSocket)

실시간 ETW 세션을 만듭니다. websocket을 통해 관리됩니다.

데이터 반환

  • 사용하도록 설정된 공급자의 ETW 이벤트

홀로그램 OS

/api/holographic/os/etw/customproviders(GET)

시스템에 등록되지 않은 HoloLens 관련 ETW 공급자 목록을 반환합니다.

/api/holographic/os/services(GET)

실행 중인 모든 서비스의 상태를 반환합니다.

/api/holographic/os/settings/ipd(GET)

저장된 IPD(보조 거리)를 밀리미터 단위로 가져옵니다.

/api/holographic/os/settings/ipd(POST)

IPD를 설정합니다.

매개 변수

  • ipd: 밀리미터 단위로 설정할 새 IPD 값

/api/holographic/os/webmanagement/settings/https(GET)

디바이스 포털에 대한 HTTPS 요구 사항을 가져옵니다.

/api/holographic/os/webmanagement/settings/https(POST)

디바이스 포털에 대한 HTTPS 요구 사항을 설정합니다.

매개 변수

  • 필수: 예, 아니요 또는 기본값

홀로그램 인식

/api/holographic/perception/client(GET/WebSocket)

WebSocket 업그레이드를 수락하고 30fps로 업데이트를 보내는 인식 클라이언트를 실행합니다.

매개 변수

  • clientmode: "활성"은 수동적으로 설정할 수 없는 경우 시각적 추적 모드를 강제로 수행합니다.

홀로그램 열

이러한 열 API를 사용하는 경우 전원 및 열 관리 문서를 참조하세요.

/api/holographic/thermal/stage(GET)

디바이스의 열 단계(정상 0개, 웜 1개, 위험 2개)를 가져옵니다.

/api/holographic/thermal/getMitigationLevels(GET/websocket)

websocket을 열거나 단일 HTTP GET 쿼리를 수행하여 다음을 포함하는 개체 목록을 반환합니다.

  • IsSuppressed - 지정된 주변 장치가 완화를 억제했는지 확인
  • 수준 - 이 주변 기기에 대한 최신 열 완화 수준
  • 마스크 - 이 주변 장치 마스크
  • ThermalScore - 이 주변 기기에 대한 최신 열 점수

개체 이름은 주변 장치 이름으로 지정됩니다(예: 배터리).

/api/holographic/thermal/setMitigationLevel(POST)

지정된 주변 디바이스에 대해 보고되는 완화 수준 변경

매개 변수

  • mask: 관심 있는 주변 장치에 대해 단일 비트가 설정된 비트 마스크(자세한 내용은 PowerThermalPeripheralFlags 참조)
  • level: 사용할 새 수준(0-3)

/api/holographic/thermal/setThermalScore(POST)

지정된 주변 장치에서 보고되는 열 점수 변경

매개 변수

  • mask: 관심 있는 주변 장치에 대해 단일 비트가 설정된 비트 마스크(자세한 내용은 PowerThermalPeripheralFlags 참조)
  • thermalScore: 사용할 새로운 열 점수(100-0)

맵 관리자

/api/holographic/mapmanager/mapFiles(GET)

사용 가능한 맵 파일(.mapx)의 목록을 가져옵니다.

/api/holographic/mapmanager/anchorFiles(GET)

사용 가능한 앵커 파일(.ancx)의 목록을 가져옵니다.

/api/holographic/mapmanager/srdbFiles(GET)

사용 가능한 공간 재구성 데이터베이스 파일(.srdb)의 목록을 가져옵니다.

/api/holographic/mapmanager/getanchors(GET)

현재 사용자의 지속형 앵커 목록을 가져옵니다.

파일 다운로드/업로드/삭제

/api/holographic/mapmanager/download(GET)

지도, 앵커 또는 공간 재구성 데이터베이스 파일을 다운로드합니다. 파일이 이전에 업로드되거나 내보내졌어야 합니다.

매개 변수

  • FileName: 다운로드할 파일의 이름입니다.

예제:

$.post("/api/holographic/mapmanager/download?FileName=" + spaceID)

/api/holographic/mapmanager/upload(POST)

맵, 앵커 또는 공간 재구성 데이터베이스 파일을 업로드합니다. 파일이 업로드되면 나중에 시스템에서 가져오고 사용할 수 있습니다.

매개 변수

  • file: 업로드할 파일의 이름입니다.

예제:

var form_data = new FormData();
form_data.append("file", file_data);

$.ajax({
    url: "/api/holographic/mapmanager/upload",
    dataType: 'json',
    cache: false,
    contentType: false,
    processData: false,
    data: form_data,
    type: 'post'
})

/api/holographic/mapmanager/delete(POST)

지도, 앵커 또는 공간 재구성 데이터베이스 파일을 삭제합니다. 파일이 이전에 업로드되거나 내보내졌어야 합니다.

매개 변수

  • FileName: 삭제할 파일의 이름입니다.

예제:

$.post("/api/holographic/mapmanager/delete?FileName=" + spaceID)

내보내기

/api/holographic/mapmanager/export(POST)

시스템에서 현재 사용 중인 맵을 내보냅니다. 내보낸 후에는 다운로드할 수 있습니다.

예제:

$.post("/api/holographic/mapmanager/export")

/api/holographic/mapmanager/exportanchors(POST)

시스템에서 현재 사용 중인 맵을 내보냅니다. 내보낸 후에는 다운로드할 수 있습니다. 예제:

$.post("/api/holographic/mapmanager/exportanchors")

/api/holographic/mapmanager/exportmapandanchors(POST)

시스템에서 현재 사용 중인 맵 및 앵커를 내보냅니다. 내보낸 후에는 다운로드할 수 있습니다. 예제:

$.post("/api/holographic/mapmanager/exportmapandanchors")

/api/holographic/mapmanager/exportmapandspatialmappingdb(POST)

시스템에서 현재 사용 중인 맵 및 공간 재구성 데이터베이스를 내보냅니다. 내보낸 후에는 다운로드할 수 있습니다.

예제:

$.post("/api/holographic/mapmanager/exportmapandspatialmappingdb")

가져오기

/api/holographic/mapmanager/import(POST)

맵을 사용해야 하는 시스템을 나타냅니다. 내보내거나 업로드한 파일에서 호출할 수 있습니다.

매개 변수

  • FileName: 사용할 맵의 이름입니다.

예제:

$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })

/api/holographic/mapmanager/importanchors(POST)

앵커를 사용해야 하는 시스템을 나타냅니다. 내보내거나 업로드한 파일에서 호출할 수 있습니다.

매개 변수

  • FileName: 사용할 앵커의 이름입니다.

예제:

$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })

/api/holographic/mapmanager/importspatialmappingdb(POST)

공간 재구성 데이터베이스를 사용해야 하는 시스템을 나타냅니다. 내보내거나 업로드한 파일에서 호출할 수 있습니다.

매개 변수

  • FileName: 사용할 공간 매핑 db의 이름입니다.

예제:

$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })

기타

/api/holographic/mapmanager/resetmapandanchorsandsrdb(POST)

시스템을 맵, 앵커 및 공간 재구성 데이터베이스로 다시 설정합니다.

예제:

$.post("/api/holographic/mapmanager/resetmapandanchorsandsrdb")

/api/holographic/mapmanager/상태(GET)

마지막으로 가져온 맵, 앵커 및 공간 재구성 데이터베이스 파일을 포함하여 시스템의 상태 가져옵니다.

혼합 현실 캡처

/api/holographic/mrc/file(GET)

디바이스에서 혼합 현실 파일을 다운로드합니다. 스트리밍에 op=stream 쿼리 매개 변수를 사용합니다.

매개 변수

  • filename: 가져올 비디오 파일의 이름, hex64로 인코딩됨
  • op: stream

/api/holographic/mrc/file(DELETE)

디바이스에서 혼합 현실 기록을 삭제합니다.

매개 변수

  • filename: 삭제할 파일의 이름, hex64로 인코딩된 파일

/api/holographic/mrc/files(GET)

디바이스에 저장된 혼합 현실 파일 목록을 반환합니다.

/api/holographic/mrc/photo(POST)

혼합 현실 사진을 찍고 디바이스에 파일을 만듭니다.

매개 변수

  • holo: 홀로그램 캡처: true 또는 false(기본값은 false)
  • pv: 캡처 PV 카메라: true 또는 false(기본값은 false)
  • RenderFromCamera: (HoloLens 2만 해당) 사진/비디오 카메라의 관점에서 렌더링: true 또는 false(기본값: true)

/api/holographic/mrc/settings(GET)

기본 혼합 현실 캡처 설정을 가져옵니다.

/api/holographic/mrc/settings(POST)

기본 혼합 현실 캡처 설정을 설정합니다. 이러한 설정 중 일부는 시스템의 MRC 사진 및 비디오 캡처에 적용됩니다.

/api/holographic/mrc/상태(GET)

Windows 디바이스 포털 내에서 혼합 현실 캡처의 상태를 가져옵니다.

응답

응답에는 Windows 디바이스 포털이 비디오를 녹화하고 있는지 여부를 나타내는 JSON 속성이 포함되어 있습니다.

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail(GET)

지정된 파일의 썸네일 이미지를 가져옵니다.

매개 변수

  • filename: 썸네일이 요청되는 파일의 이름, hex64로 인코딩됨

/api/holographic/mrc/video/control/start(POST)

혼합 현실 기록을 시작합니다.

매개 변수

  • holo: 홀로그램 캡처: true 또는 false(기본값은 false)
  • pv: 캡처 PV 카메라: true 또는 false(기본값은 false)
  • 마이크: 캡처 마이크: true 또는 false(기본값은 false)
  • 루프백: 앱 오디오 캡처: true 또는 false(기본값은 false)
  • RenderFromCamera: (HoloLens 2만 해당) 사진/비디오 카메라의 관점에서 렌더링: true 또는 false(기본값: true)
  • vstab: (HoloLens 2만 해당) 비디오 손떨림 보정 사용: true 또는 false(기본값: true)
  • vstabbuffer: (HoloLens 2 전용) 비디오 안정화 버퍼 대기 시간: 0~30프레임(기본값: 15프레임)

/api/holographic/mrc/video/control/stop(POST)

현재 혼합 현실 기록을 중지합니다.

Mixed Reality 스트리밍

주의

루프백 격리로 인해 디바이스의 앱 내에서 혼합 현실 스트리밍에 연결할 수 없습니다.

HoloLens는 조각화된 mp4의 청크 다운로드를 통해 혼합 현실의 라이브 미리 보기를 지원합니다.

혼합 현실 스트림은 캡처된 내용을 제어하기 위해 동일한 매개 변수 집합을 공유합니다.

  • holo: 홀로그램 캡처: true 또는 false
  • pv: PV 카메라 캡처: true 또는 false
  • 마이크: 마이크 캡처: true 또는 false
  • 루프백: 앱 오디오 캡처: true 또는 false

이 중 어느 것도 지정하지 않으면 홀로그램, 사진/비디오 카메라 및 앱 오디오가 캡처됩니다.

지정된 매개 변수가 있으면 지정되지 않은 매개 변수는 기본적으로 false로 설정됩니다.

선택적 매개 변수(HoloLens 2만 해당)

  • RenderFromCamera: 사진/비디오 카메라의 관점에서 렌더링: true 또는 false(기본값: true)
  • vstab: 비디오 손떨림 보정 사용: true 또는 false(기본값은 false)
  • vstabbuffer: 비디오 안정화 버퍼 대기 시간: 0~30프레임(기본값: 15프레임)

/api/holographic/stream/live.mp4(GET)

1280x720p 30fps 5Mbit 스트림.

/api/holographic/stream/live_high.mp4(GET)

1280x720p 30fps 5Mbit 스트림.

/api/holographic/stream/live_med.mp4(GET)

854x480p 30fps 2.5Mbit 스트림.

/api/holographic/stream/live_low.mp4(GET)

428x240p 15fps 0.6Mbit 스트림.

네트워킹

/api/networking/ipconfig(GET)

현재 IP 구성을 가져옵니다.

OS 정보

/api/os/info(GET)

운영 체제 정보를 가져옵니다.

/api/os/machinename(GET)

컴퓨터 이름을 가져옵니다.

/api/os/machinename(POST)

컴퓨터 이름을 설정합니다.

매개 변수

  • name: 설정할 새 컴퓨터 이름, hex64로 인코딩됨

인식 시뮬레이션 제어

/api/holographic/simulation/control/mode(GET)

시뮬레이션 모드를 가져옵니다.

/api/holographic/simulation/control/mode(POST)

시뮬레이션 모드를 설정합니다.

매개 변수

  • mode: 시뮬레이션 모드: 기본, 시뮬레이션, 원격, 레거시

/api/holographic/simulation/control/stream(DELETE)

컨트롤 스트림을 삭제합니다.

/api/holographic/simulation/control/stream(GET/WebSocket)

컨트롤 스트림에 대한 WebSocket 연결을 엽니다.

/api/holographic/simulation/control/stream(POST)

컨트롤 스트림을 만들거나(우선 순위가 필요) 만든 스트림에 데이터를 게시합니다(streamId 필요). 게시된 데이터는 'application/octet-stream' 형식이어야 합니다.

/api/holographic/simulation/display/stream(GET/WebSocket)

'시뮬레이션' 모드일 때 시스템 디스플레이에 렌더링된 콘텐츠가 포함된 시뮬레이션 비디오 스트림을 요청합니다. 처음에는 간단한 형식 설명자 헤더가 전송되고 H.264로 인코딩된 텍스처가 전송되며, 각각 앞에 눈 색인과 텍스처 크기를 나타내는 헤더가 있습니다.

인식 시뮬레이션 재생

/api/holographic/simulation/playback/file(DELETE)

기록을 삭제합니다.

매개 변수

  • recording: 삭제할 기록의 이름입니다.

/api/holographic/simulation/playback/file(POST)

녹음/녹화를 업로드합니다.

/api/holographic/simulation/playback/files(GET)

모든 녹음/녹화를 가져옵니다.

/api/holographic/simulation/playback/session(GET)

기록의 현재 재생 상태를 가져옵니다.

매개 변수

  • recording: 녹음/녹화의 이름입니다.

/api/holographic/simulation/playback/session/file(DELETE)

기록을 언로드합니다.

매개 변수

  • recording: 언로드할 기록의 이름입니다.

/api/holographic/simulation/playback/session/file(POST)

기록을 로드합니다.

매개 변수

  • recording: 로드할 기록의 이름입니다.

/api/holographic/simulation/playback/session/files(GET)

로드된 모든 기록을 가져옵니다.

/api/holographic/simulation/playback/session/pause(POST)

녹음/녹화를 일시 중지합니다.

매개 변수

  • recording: 녹음/녹화의 이름입니다.

/api/holographic/simulation/playback/session/play(POST)

녹음/녹화를 재생합니다.

매개 변수

  • recording: 녹음/녹화의 이름입니다.

/api/holographic/simulation/playback/session/stop(POST)

기록을 중지합니다.

매개 변수

  • recording: 녹음/녹화의 이름입니다.

/api/holographic/simulation/playback/session/types(GET)

로드된 기록에서 데이터 형식을 가져옵니다.

매개 변수

  • recording: 녹음/녹화의 이름입니다.

인식 시뮬레이션 기록

/api/holographic/simulation/recording/start(POST)

녹음/녹화를 시작합니다. 한 번에 하나의 기록만 활성화할 수 있습니다. 머리, 손, spatialMapping 또는 환경 중 하나를 설정해야 합니다.

매개 변수

  • head: 헤드 데이터를 기록하려면 1로 설정합니다.
  • 손: 손 데이터를 기록하려면 1로 설정합니다.
  • spatialMapping: 공간 매핑을 기록하려면 1로 설정합니다.
  • environment: 환경 데이터를 기록하려면 1로 설정합니다.
  • name: 녹음/녹화의 이름입니다.
  • singleSpatialMappingFrame: 단일 공간 매핑 프레임만 기록하려면 1로 설정합니다.

/api/holographic/simulation/recording/상태(GET)

기록 상태를 가져옵니다.

/api/holographic/simulation/recording/stop(GET)

현재 기록을 중지합니다. 녹음/녹화가 파일로 반환됩니다.

성능 데이터

/api/resourcemanager/processes(GET)

세부 정보가 포함된 실행 중인 프로세스 목록을 반환합니다.

데이터 반환

  • 각 프로세스에 대한 프로세스 및 세부 정보 목록이 포함된 JSON

/api/resourcemanager/systemperf(GET)

시스템 성능 통계(I/O 읽기/쓰기, 메모리 통계 등)를 반환합니다.

데이터 반환

  • 시스템 정보가 포함된 JSON: CPU, GPU, 메모리, 네트워크, IO

고급

/api/전원/배터리(GET)

현재 배터리 상태를 가져옵니다.

/api/power/state(GET)

시스템이 저전력 상태인지 확인합니다.

원격 제어

/api/control/restart(POST)

대상 디바이스를 다시 시작합니다.

/api/control/shutdown(POST)

대상 디바이스를 종료합니다.

작업 관리자

/api/taskmanager/app(DELETE)

최신 앱을 중지합니다.

매개 변수

  • 패키지: 앱 패키지의 전체 이름, hex64로 인코딩됨
  • forcetop: 모든 프로세스를 강제로 중지(=예)

/api/taskmanager/app(POST)

최신 앱 시작

매개 변수

  • appid: 시작할 앱의 PRAID, hex64로 인코딩됨
  • 패키지: 앱 패키지의 전체 이름, hex64로 인코딩됨

WiFi Management

/api/wifi/interfaces(GET)

무선 네트워크 인터페이스를 열거합니다.

데이터 반환

  • 세부 정보가 포함된 무선 인터페이스 목록(GUID, 설명 등)

/api/wifi/network(DELETE)

지정된 인터페이스에서 네트워크와 연결된 프로필을 삭제합니다.

매개 변수

  • interface: 네트워크 인터페이스 guid
  • profile: 프로필 이름

/api/wifi/networks(GET)

지정된 네트워크 인터페이스에서 무선 네트워크를 열거합니다.

매개 변수

  • interface: 네트워크 인터페이스 guid

데이터 반환

  • 세부 정보가 포함된 네트워크 인터페이스에 있는 무선 네트워크 목록

/api/wifi/network(POST)

지정된 인터페이스의 네트워크에 연결하거나 연결을 끊습니다.

매개 변수

  • interface: 네트워크 인터페이스 guid
  • ssid: ssid, hex64로 인코딩되어 연결
  • op: 연결 또는 연결 끊기
  • createprofile: 예 또는 아니요
  • key: 공유 키, hex64로 인코딩됨

Windows Performance Recorder

/api/wpr/customtrace(POST)

WPR 프로필을 업로드하고 업로드된 프로필을 사용하여 추적을 시작합니다.

Payload

  • http 본문을 준수하는 다중 파트

데이터 반환

  • WPR 세션 상태 반환합니다.

/api/wpr/상태(GET)

WPR 세션의 상태 검색합니다.

데이터 반환

  • WPR 세션 상태.

/api/wpr/trace(GET)

WPR(성능) 추적 세션을 중지합니다.

데이터 반환

  • 추적 ETL 파일을 반환합니다.

/api/wpr/trace(POST)

WPR(성능) 추적 세션을 시작합니다.

매개 변수

  • profile: 프로필 이름입니다. 사용 가능한 프로필은 perfprofiles/profiles.json에 저장됩니다.

데이터 반환

  • 시작 시 WPR 세션 상태 반환합니다.

추가 정보