Cihaz portalı API başvurusu

Windows Cihaz Portalı'ndaki her şey, verilere erişmek ve cihazınızı program aracılığıyla denetlemek için kullanabileceğiniz REST API'lerinin üzerine kurulmuştur.

Uygulama dağıtımı

/api/app/packagemanager/package (DELETE)

Bir uygulamayı kaldırır.

Parametreler

• package: Kaldırılacak paketin dosya adı.

/api/app/packagemanager/package (POST)

Bir Uygulama yükler.

Parametreler

• package: Yüklenecek paketin dosya adı.

Yükü

• çok parçalı uyumlu http gövdesi

/api/app/packagemanager/packages (GET)

Sistemdeki yüklü uygulamaların listesini alır. Ayrıntıları içerir.

Veri döndürme

• Ayrıntıları içeren yüklü paketlerin listesi

/api/app/packagemanager/state (GET)

Devam eden uygulama yüklemesinin durumunu alır.

Döküm koleksiyonu

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

Dışarıdan yüklenen bir uygulama için kilitlenme dökümü koleksiyonunu devre dışı bırakır.

Parametreler

• packageFullName: paket adı

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

Dışarıdan yüklenen uygulamaların kilitlenme bilgi dökümü koleksiyonu ayarlarını alır.

Parametreler

• packageFullName: paket adı

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

Dışarıdan yüklenen bir uygulama için döküm denetimi ayarlarını etkinleştirir ve ayarlar.

Parametreler

• packageFullName: paket adı

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

Dışarıdan yüklenen bir uygulama için kilitlenme dökümünü siler.

Parametreler

• packageFullName: paket adı
• fileName: döküm dosyası adı

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

Dışarıdan yüklenen bir uygulama için kilitlenme dökümünü alır.

Parametreler

• packageFullName: paket adı
• fileName: döküm dosyası adı

Veri döndürme

• Döküm dosyası. WinDbg veya Visual Studio ile inceleyin.

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

Dışarıdan yüklenen uygulamalar için tüm kilitlenme dökümlerinin listesini döndürür.

Veri döndürme

• Dışarıdan yüklenen uygulama başına kilitlenme bilgi dökümleri listesi

ETW

/api/etw/providers (GET)

Kayıtlı sağlayıcıları numaralandırır.

Veri döndürme

• Sağlayıcı listesi, kolay ad ve GUID

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

Gerçek zamanlı bir ETW oturumu oluşturur; bir websocket üzerinden yönetilir.

Veri döndürme

• Etkin sağlayıcılardan ETW olayları

Holografik işletim sistemi

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

Sisteme kayıtlı olmayan HoloLens'e özgü ETW sağlayıcılarının listesini döndürür.

/api/holographic/os/services (GET)

Çalışan tüm hizmetlerin durumlarını döndürür.

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

Depolanan IPD'yi (Interpupillary distance) milimetre olarak alır.

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

IPD'yi ayarlar.

Parametreler

• ipd: Milimetre olarak ayarlanacak yeni IPD değeri

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

Cihaz Portalı için HTTPS gereksinimlerini alır.

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

Cihaz Portalı için HTTPS gereksinimlerini ayarlar.

Parametreler

• gerekli: evet, hayır veya varsayılan

Holografik Algı

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

WebSocket yükseltmelerini kabul eder ve güncelleştirmeleri 30 fps'de gönderen bir algı istemcisi çalıştırır.

Parametreler

• clientmode: "etkin", pasif olarak kurulamazken görsel izleme modunu zorlar

Holografik Termal

Bu termal API'leri kullanırken yönetim gücü ve termaller makalesine bakın.

/api/holographic/thermal/stage (GET)

Cihazın termal aşamasını alın (0 normal, 1 sıcak, 2 kritik).

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

Aşağıdakileri içeren nesnelerin listesini döndürerek bir websocket açın (veya tek bir HTTP GET sorgusu yapın):

• IsSuppressed - Belirli bir çevre biriminin azaltmaları engellenip gizlenmediğini belirleme
• Düzey - Bu çevre birimi için en son termal risk azaltma düzeyi
• Maske - Bu çevre biriminin maskesi
• ThermalScore - Bu çevre birimi için en son termal puan

Nesneler çevre birimi adıyla adlandırılır (Örnek: Pil)

/api/holographic/thermal/setMitigationLevel (POST)

Belirli bir çevre birimi için bildirilen risk azaltma düzeyini değiştirme

Parametreler

• maske: İlgi alanı çevre birimi için tek bit ayarlanmış bit maskesi (ayrıntılar için bkz . PowerThermalPeripheralFlags )
• level: kullanılacak yeni düzey (0-3)

/api/holographic/thermal/setThermalScore (POST)

Belirli bir çevre birimi için bildirilen termal puanı değiştirme

Parametreler

• mask: ilgilendiğiniz çevre birimi için tek bit ayarlanmış bit maskesi (Ayrıntılar için bkz . PowerThermalPeripheralFlags )
• thermalScore: kullanılacak yeni termal puan (100-0)

Harita Yöneticisi

/api/holographic/mapmanager/mapFiles (GET)

Kullanılabilir harita dosyalarının (.mapx) listesini alır.

/api/holographic/mapmanager/anchorFiles (GET)

Kullanılabilir yer işareti dosyalarının (.ancx) listesini alır.

/api/holographic/mapmanager/srdbFiles (GET)

Kullanılabilir uzamsal yeniden yapılandırma veritabanı dosyalarının (.srdb) listesini alır.

/api/holographic/mapmanager/getanchors (GET)

Geçerli kullanıcı için kalıcı yer işaretleri listesini alır.

Dosyaları İndirme/Karşıya Yükleme/Silme

/api/holographic/mapmanager/download (GET)

Harita, yer işareti veya uzamsal yeniden yapılandırma veritabanı dosyasını indirir. Dosya daha önce karşıya yüklenmiş veya dışarı aktarılmış olmalıdır.

Parametreler

• FileName: İndirilmesi gereken dosyanın adı.

Örnek:

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

/api/holographic/mapmanager/upload (POST)

Harita, yer işareti veya uzamsal yeniden yapılandırma veritabanı dosyasını karşıya yükler. Bir dosya karşıya yüklendikten sonra içeri aktarılabilir ve sistem tarafından kullanılabilir.

Parametreler

• file: Karşıya yüklenecek dosyanın adı.

Örnek:

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)

Harita, yer işareti veya uzamsal yeniden yapılandırma veritabanı dosyasını siler. Dosya daha önce karşıya yüklenmiş veya dışarı aktarılmış olmalıdır.

Parametreler

• FileName: Silinecek dosyanın adı.

Örnek:

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

Dışarı Aktarma

/api/holographic/mapmanager/export (POST)

Sistem tarafından kullanılmakta olan haritayı dışarı aktarır. Dışarı aktarıldıktan sonra indirilebilir.

Örnek:

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

/api/holographic/mapmanager/exportanchors (POST)

Sistem tarafından kullanılmakta olan haritayı dışarı aktarır. Dışarı aktarıldıktan sonra indirilebilir. Örnek:

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

/api/holographic/mapmanager/exportmapandanchors (POST)

Sistem tarafından kullanılmakta olan haritayı ve tutturucuları dışarı aktarır. Dışarı aktarıldıktan sonra indirilebilirler. Örnek:

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

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

Şu anda sistem tarafından kullanılmakta olan harita ve uzamsal yeniden yapılandırma veritabanını dışarı aktarır. Dışarı aktarıldıktan sonra indirilebilirler.

Örnek:

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

İçeri Aktar

/api/holographic/mapmanager/import (POST)

Sisteme hangi eşlemenin kullanılacağını gösterir. Dışarı aktarılan veya karşıya yüklenen dosyalarda çağrılabilir.

Parametreler

• FileName: Kullanılacak eşlemenin adı.

Örnek:

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

/api/holographic/mapmanager/importanchors (POST)

Sisteme hangi tutturucuların kullanılması gerektiğini gösterir. Dışarı aktarılan veya karşıya yüklenen dosyalarda çağrılabilir.

Parametreler

• FileName: Kullanılacak tutturucuların adı.

Örnek:

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

/api/holographic/mapmanager/importspatialmappingdb (POST)

Sisteme hangi uzamsal yeniden yapılandırma veritabanının kullanılması gerektiğini gösterir. Dışarı aktarılan veya karşıya yüklenen dosyalarda çağrılabilir.

Parametreler

• FileName: Kullanılacak uzamsal eşleme db'nin adı.

Örnek:

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

Diğer

/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

Sistemi harita, yer işaretleri ve uzamsal yeniden yapılandırma veritabanını sıfırlayın.

Örnek:

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

/api/holographic/mapmanager/status (GET)

En son hangi harita, yer işaretleri ve uzamsal yeniden yapılandırma veritabanı dosyalarının içeri aktarıldığı da dahil olmak üzere sistemin durumunu alır.

yakalamayı Karma Gerçeklik

/api/holographic/mrc/file (GET)

Cihazdan bir karma gerçeklik dosyası indirir. Akış için op=stream sorgu parametresini kullanın.

Parametreler

• filename: Alınacak video dosyasının adı, onaltılık kodlanmış
• op: stream

/api/holographic/mrc/file (DELETE)

Karma gerçeklik kaydını cihazdan siler.

Parametreler

• filename: Silinecek dosyanın adı, onaltılık kodlanmış

/api/holographic/mrc/files (GET)

Cihazda depolanan karma gerçeklik dosyalarının listesini döndürür.

/api/holographic/mrc/photo (POST)

Karma gerçeklik fotoğrafı çeker ve cihazda bir dosya oluşturur.

Parametreler

• holo: yakalama hologramları: true veya false (varsayılan olarak false)
• pv: PV kamera yakalama: true veya false (varsayılan olarak false)
• RenderFromCamera: (yalnızca HoloLens 2) fotoğraf/video kamerası perspektifinden işleme: true veya false (varsayılan olarak true)

/api/holographic/mrc/settings (GET)

Varsayılan karma gerçeklik yakalama ayarlarını alır.

/api/holographic/mrc/settings (POST)

Varsayılan karma gerçeklik yakalama ayarlarını ayarlar. Bu ayarlardan bazıları sistemin MRC fotoğrafına ve video yakalamasına uygulanır.

/api/holographic/mrc/status (GET)

Windows Cihaz Portalı'nın içinde karma gerçeklik yakalama durumunu alır.

Yanıt

Yanıt, Windows Cihaz Portalı'nın video kaydedip kaydetmediğini belirten bir JSON özelliği içerir.

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail (GET)

Belirtilen dosya için küçük resim görüntüsünü alır.

Parametreler

• filename: Küçük resmin istendiği dosyanın adı, onaltılık kodlanmış

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

Karma gerçeklik kaydı başlatır.

Parametreler

• holo: yakalama hologramları: true veya false (varsayılan olarak false)
• pv: PV kamera yakalama: true veya false (varsayılan olarak false)
• mikrofon: mikrofon yakalama: true veya false (varsayılan olarak false)
• geri döngü: uygulama sesini yakalama: true veya false (varsayılan olarak false)
• RenderFromCamera: (yalnızca HoloLens 2) fotoğraf/video kamerası perspektifinden işleme: true veya false (varsayılan olarak true)
• vstab: (yalnızca HoloLens 2) video sabitlemeyi etkinleştir: true veya false (varsayılan olarak true)
• vstabbuffer: (yalnızca HoloLens 2) video sabitleme arabelleği gecikme süresi: 0 - 30 kare (varsayılan olarak 15 kare)

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

Geçerli karma gerçeklik kaydını durdurur.

Karma Gerçeklik Akışı

Dikkat

Geri döngü yalıtımı nedeniyle, cihazdaki bir uygulamanın içinden karma gerçeklik akışına bağlanamazsınız.

HoloLens, parçalanmış mp4'ün öbekli indirmesi aracılığıyla karma gerçekliğin canlı önizlemesini destekler.

Karma gerçeklik akışları, yakalananları denetlemek için aynı parametre kümesini paylaşır:

• holo: hologramları yakalama: true veya false
• pv: PV kamera yakalama: true veya false
• mikrofon: mikrofon yakalama: true veya false
• geri döngü: uygulama sesini yakalama: true veya false

Bunların hiçbiri belirtilmezse hologramlar, fotoğraf/video kamera ve uygulama sesi yakalanır.

Herhangi biri belirtilirse belirtilmeyen parametreler varsayılan olarak false olur

İsteğe bağlı parametreler (yalnızca HoloLens 2)

• RenderFromCamera: fotoğraf/video kamerası perspektifinden işleme: true veya false (varsayılan olarak true)
• vstab: video sabitlemeyi etkinleştir: true veya false (varsayılan olarak false)
• vstabbuffer: video sabitleme arabellek gecikme süresi: 0 - 30 kare (varsayılan olarak 15 kare)

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

1280x720p 30fps 5Mbit akış.

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

1280x720p 30fps 5Mbit akış.

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

854x480p 30fps 2.5Mbit akış.

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

428x240p 15fps 0.6Mbit akış.

Ağ

/api/networking/ipconfig (GET)

Geçerli IP yapılandırmasını alır.

İşletim Sistemi Bilgileri

/api/os/info (GET)

İşletim sistemi bilgilerini alır.

/api/os/machinename (GET)

Makine adını alır.

/api/os/machinename (POST)

Makine adını ayarlar.

Parametreler

• name: Yeni makine adı, onaltılık kodlanmış, ayarlanacağı

Algı Benzetimi Denetimi

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

Simülasyon modunu alır.

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

Simülasyon modunu ayarlar.

Parametreler

• mod: simülasyon modu: varsayılan, simülasyon, uzak, eski

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

Denetim akışını silme.

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

Denetim akışı için bir WebSocket bağlantısı açın.

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

Denetim akışı oluşturun (öncelik gereklidir) veya verileri oluşturulan bir akışa gönderin (streamId gereklidir). Gönderilen verilerin 'application/octet-stream' türünde olması beklenir.

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

'Simülasyon' modundayken sistem ekranında işlenen içeriği içeren bir simülasyon video akışı isteyin. Başlangıçta basit bir biçim tanımlayıcı üst bilgisi gönderilir ve ardından H.264 ile kodlanmış dokular gönderilir ve her biri göz dizini ve doku boyutunu gösteren bir üst bilgi gelir.

Algı Benzetimi Kayıttan Yürütme

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

Kaydı silme.

Parametreler

• kayıt: Silinecek kaydın adı.

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

Bir kaydı karşıya yükleyin.

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

Tüm kayıtları alın.

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

Kaydın geçerli kayıttan yürütme durumunu alma.

Parametreler

• kayıt: Kaydın adı.

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

Kaydı kaldırın.

Parametreler

• kayıt: Kaldırılan kaydın adı.

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

Bir kayıt yükleyin.

Parametreler

• kayıt: Yüklenemiyor kaydın adı.

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

Tüm yüklü kayıtları alın.

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

Kaydı duraklatma.

Parametreler

• kayıt: Kaydın adı.

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

Kayıt oynat.

Parametreler

• kayıt: Kaydın adı.

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

Kaydı durdurun.

Parametreler

• kayıt: Kaydın adı.

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

Yüklenen kayıttaki veri türlerini alın.

Parametreler

• kayıt: Kaydın adı.

Algı Simülasyonu Kaydı

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

Kaydı başlatın. Aynı anda yalnızca tek bir kayıt etkin olabilir. Bunlardan biri ayarlanmalıdır: baş, eller, uzamsal eşleme veya ortam.

Parametreler

• head: Baş verilerini kaydetmek için 1 olarak ayarlayın.
• hands: El verilerini kaydetmek için 1 olarak ayarlayın.
• spatialMapping: Uzamsal eşlemeyi kaydetmek için 1 olarak ayarlayın.
• environment: Ortam verilerini kaydetmek için 1 olarak ayarlayın.
• name: Kaydın adı.
• singleSpatialMappingFrame: Yalnızca tek bir uzamsal eşleme çerçevesini kaydetmek için 1 olarak ayarlayın.

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

Kayıt durumunu alma.

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

Geçerli kaydı durdurun. Kayıt dosya olarak döndürülür.

Performans verileri

/api/resourcemanager/processes (GET)

Çalışan işlemlerin listesini ve ayrıntıları döndürür.

Veri döndürme

• İşlemlerin listesi ve her işlemin ayrıntıları ile JSON

/api/resourcemanager/systemperf (GET)

Sistem performans istatistiklerini (G/Ç okuma/yazma, bellek istatistikleri vb.) döndürür.

Veri döndürme

• Sistem bilgileriyle JSON: CPU, GPU, Bellek, Ağ, GÇ

Güç

/api/güç/pil (GET)

Geçerli pil durumunu alır.

/api/power/state (GET)

Sistemin düşük güç durumunda olup olmadığını denetler.

Uzaktan Denetim

/api/control/restart (POST)

Hedef cihazı yeniden başlatır.

/api/control/shutdown (POST)

Hedef cihazı kapatır.

Görev Yöneticisi

/api/taskmanager/app (DELETE)

Modern bir uygulamayı durdurur.

Parametreler

• package: Uygulama paketinin tam adı, onaltılık kodlanmış
• forcetop: Tüm işlemleri durmaya zorla (=evet)

/api/taskmanager/app (POST)

Modern bir uygulama başlatır

Parametreler

• appid: Başlatacak uygulamanın PRAID'i, onaltılık kodlanmış
• package: Uygulama paketinin tam adı, onaltılık kodlanmış

WiFi Yönetimi

/api/wifi/arabirimler (GET)

Kablosuz ağ arabirimlerini numaralandırır.

Veri döndürme

• Ayrıntıları olan kablosuz arabirimlerin listesi (GUID, açıklama vb.)

/api/wifi/network (DELETE)

Belirtilen arabirimdeki bir ağ ile ilişkili profili siler.

Parametreler

• interface: ağ arabirimi GUID'i
• profil: profil adı

/api/wifi/networks (GET)

Belirtilen ağ arabiriminde kablosuz ağları numaralandırır.

Parametreler

• interface: ağ arabirimi GUID'i

Veri döndürme

• Ağ arabiriminde bulunan kablosuz ağların listesi ve ayrıntılar

/api/wifi/network (POST)

Belirtilen arabirimdeki bir ağa bağlanır veya bağlantıyı keser.

Parametreler

• interface: ağ arabirimi GUID'i
• ssid: bağlanmak için ssid, onaltılık kodlanmış
• op: bağlanma veya bağlantıyı kesme
• createprofile: evet veya hayır
• key: paylaşılan anahtar, onaltılık kodlanmış

Windows Performans Kaydedicisi

/api/wpr/customtrace (POST)

WpR profilini karşıya yükler ve karşıya yüklenen profili kullanarak izlemeye başlar.

Yükü

• çok parçalı uyumlu http gövdesi

Veri döndürme

• WPR oturum durumunu döndürür.

/api/wpr/status (GET)

WPR oturumunun durumunu alır

Veri döndürme

• WPR oturum durumu.

/api/wpr/trace (GET)

WPR (performans) izleme oturumlarını durdurur.

Veri döndürme

• İzleme ETL dosyasını döndürür

/api/wpr/trace (POST)

WPR (performans) izleme oturumu başlatır.

Parametreler

• profil: Profil adı. Kullanılabilir profiller perfprofiles/profiles.json dosyasında depolanır

Veri döndürme

• Başlangıçta WPR oturum durumunu döndürür.

Ayrıca bkz.

• Windows Cihaz Portalı'nı kullanma
• Cihaz Portalı çekirdek API başvurusu (UWP)