Microsoft Windows 10

Microsoft Windows 10 Sessions API

The Sessions API from Microsoft Windows 10 — 2 operation(s) for sessions.

Documentation GitHub OpenAPI

Documentation

https://learn.microsoft.com/en-us/uwp/api/

https://learn.microsoft.com/en-us/windows/uwp/get-started/

https://learn.microsoft.com/en-us/windows/win32/apiindex/windows-api-list

https://learn.microsoft.com/en-us/windows/win32/desktop-programming

https://learn.microsoft.com/en-us/windows/uwp/design/shell/tiles-and-notifications/adaptive-interactive-toasts

https://learn.microsoft.com/en-us/windows/ai/windows-ml/api-reference

https://learn.microsoft.com/en-us/windows/ai/windows-ml/get-started

https://learn.microsoft.com/en-us/uwp/api/windows.storage

https://learn.microsoft.com/en-us/windows/uwp/files/

https://learn.microsoft.com/en-us/cortana/voice-commands/vcd

https://learn.microsoft.com/en-us/uwp/api/windows.ui.input.inking

https://learn.microsoft.com/en-us/windows/uwp/design/input/pen-and-stylus-interactions

https://learn.microsoft.com/en-us/windows/uwp/composition/visual-layer

https://learn.microsoft.com/en-us/windows/uwp/composition/using-the-visual-layer-with-xaml

https://learn.microsoft.com/en-us/windows/win32/directx

https://learn.microsoft.com/en-us/windows/win32/getting-started-with-directx-graphics

https://learn.microsoft.com/en-us/windows/apps/develop/audio-video-camera

https://learn.microsoft.com/en-us/windows/win32/medfound/audio-video-capture-in-media-foundation

https://learn.microsoft.com/en-us/windows/uwp/networking/which-networking-technology

https://learn.microsoft.com/en-us/windows/uwp/devices-sensors/bluetooth-dev-faq

https://learn.microsoft.com/en-us/windows/win32/bluetooth/bluetooth-programming-with-windows-sockets

https://learn.microsoft.com/en-us/uwp/api/windows.devices.geolocation

https://learn.microsoft.com/en-us/windows/win32/sensorsapi/introduction-to-the-sensor-and-location-platform-in-windows

https://learn.microsoft.com/en-us/windows/apps/develop/security/windows-hello

https://learn.microsoft.com/en-us/windows/apps/develop/security/windows-hello-auth-service

https://learn.microsoft.com/en-us/windows/apps/winui/winui2/

https://learn.microsoft.com/en-us/windows/apps/winui/winui2/getting-started

https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/applifecycle/background-tasks

Specifications

https://raw.githubusercontent.com/api-evangelist/microsoft-windows-10/refs/heads/main/openapi/microsoft-windows-10-sessions-api-openapi.yml

Other Resources

https://github.com/Microsoft/Windows-universal-samples

https://learn.microsoft.com/en-us/uwp/api/

https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/

https://learn.microsoft.com/en-us/windows/win32/api/

https://github.com/microsoft/Windows-classic-samples

https://github.com/WindowsNotifications/quickstart-sending-local-toast-win10

https://learn.microsoft.com/en-us/uwp/api/windows.ui.notifications

https://learn.microsoft.com/en-us/windows/ai/windows-ml/tutorials

https://github.com/Microsoft/Windows-Machine-Learning

https://learn.microsoft.com/en-us/windows/uwp/files/best-practices-for-writing-to-files

https://learn.microsoft.com/en-us/cortana/voice-commands/voicecommand-design-guidelines

https://github.com/Microsoft/Windows-universal-samples/tree/master/Samples/SimpleInk

https://learn.microsoft.com/en-us/uwp/api/windows.ui.composition

https://github.com/microsoft/Windows.UI.Composition-Win32-Samples

https://github.com/microsoft/DirectX-Graphics-Samples

https://microsoft.github.io/DirectX-Specs/

https://learn.microsoft.com/en-us/uwp/api/windows.media.capture

https://learn.microsoft.com/en-us/uwp/api/windows.networking.sockets

https://learn.microsoft.com/en-us/samples/microsoft/windows-universal-samples/websocket/

https://learn.microsoft.com/en-us/windows/win32/api/_bluetooth/

https://learn.microsoft.com/en-us/windows/win32/locationapi/windows-location-api-portal

https://learn.microsoft.com/en-us/samples/microsoft/windows-universal-samples/geolocation/

https://learn.microsoft.com/en-us/uwp/api/windows.devices.sensors

https://learn.microsoft.com/en-us/windows/security/identity-protection/hello-for-business/webauthn-apis

https://learn.microsoft.com/en-us/windows/winui/api/microsoft.ui.xaml.controls

https://github.com/microsoft/microsoft-ui-xaml

https://learn.microsoft.com/en-us/samples/microsoft/windows-universal-samples/backgroundtask/

OpenAPI Specification

openapi: 3.1.0
info:
  title: Microsoft Windows 10 Windows Background Tasks Accelerometer Sessions API
  description: API for running code in the background when an application is suspended or not running. Based on the Windows.ApplicationModel.Background namespace, it supports time-triggered, system-triggered, and maintenance-triggered background tasks. Key classes include BackgroundTaskBuilder, BackgroundTaskRegistration, SystemTrigger, TimeTrigger, and BackgroundTaskCompletedEventArgs.
  version: 1.0.0
  contact:
    name: Microsoft Developer Support
    url: https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/applifecycle/background-tasks
  license:
    name: Microsoft Software License
    url: https://www.microsoft.com/en-us/legal/terms-of-use
servers:
- url: https://api.windows.com
  description: Windows Platform API
tags:
- name: Sessions
paths:
  /media/capture/sessions:
    post:
      operationId: initializeMediaCapture
      summary: Microsoft Windows 10 Initialize a media capture session
      description: Initializes a MediaCapture session with specified settings using MediaCapture.InitializeAsync. The MediaCaptureInitializationSettings specify the video and audio device, streaming category, and sharing mode.
      tags:
      - Sessions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitializeCaptureRequest'
      responses:
        '201':
          description: Capture session initialized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaptureSession'
        '400':
          description: Invalid initialization settings
        '403':
          description: Camera/microphone access denied
  /ml/sessions:
    post:
      operationId: createMLSession
      summary: Microsoft Windows 10 Create an evaluation session
      description: Creates a LearningModelSession for evaluating a loaded model. The session binds the model to a LearningModelDevice (CPU, DirectX, or DirectXHighPerformance) for hardware-accelerated inference.
      tags:
      - Sessions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSessionRequest'
      responses:
        '201':
          description: Session created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LearningModelSession'
        '400':
          description: Invalid session configuration
        '404':
          description: Model not found
components:
  schemas:
    InitializeCaptureRequest:
      type: object
      properties:
        videoDeviceId:
          type: string
          description: Video capture device ID
        audioDeviceId:
          type: string
          description: Audio capture device ID
        streamingCaptureMode:
          type: string
          enum:
          - AudioAndVideo
          - Audio
          - Video
          default: AudioAndVideo
        sharingMode:
          type: string
          enum:
          - ExclusiveControl
          - SharedReadOnly
          default: ExclusiveControl
        photoCaptureSource:
          type: string
          enum:
          - Auto
          - VideoPreview
          - Photo
          default: Auto
    LearningModelSession:
      type: object
      description: An evaluation session (LearningModelSession class)
      properties:
        id:
          type: string
          description: Session identifier
        modelId:
          type: string
          description: Associated model identifier
        device:
          $ref: '#/components/schemas/LearningModelDevice'
    CreateSessionRequest:
      type: object
      properties:
        modelId:
          type: string
          description: ID of the loaded model
        deviceKind:
          type: string
          enum:
          - Default
          - Cpu
          - DirectX
          - DirectXHighPerformance
          - DirectXMinPower
          description: The device to use for evaluation (maps to LearningModelDeviceKind)
          default: Default
      required:
      - modelId
    CaptureSession:
      type: object
      description: An initialized media capture session
      properties:
        id:
          type: string
          description: Session identifier
        state:
          type: string
          enum:
          - Initialized
          - Previewing
          - Recording
          - Paused
        videoDeviceId:
          type: string
        audioDeviceId:
          type: string
    LearningModelDevice:
      type: object
      description: A device for model evaluation (LearningModelDevice class)
      properties:
        kind:
          type: string
          enum:
          - Default
          - Cpu
          - DirectX
          - DirectXHighPerformance
          - DirectXMinPower
          description: Device kind
        adapterId:
          type: string
          description: GPU adapter ID (for DirectX devices)
        name:
          type: string
          description: Device name
externalDocs:
  description: Background Tasks Documentation
  url: https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/applifecycle/background-tasks