@yodaos-pkg/ink 0.17.0 → 0.17.1

package/index.d.ts

@@ -709,26 +709,102 @@ export interface InkHostSensorControlRequest {
 }
 
 /**
- * Host-controlled audio recording options passed into
- * `hostCapabilities.media.startAudioRecording()`.
+ * Host-visible device descriptor returned from `hostCapabilities.media.enumerateDevices()`.
  */
-export interface InkHostAudioRecordingOptions {
-  /** Requested sample rate in hertz. */
+export interface InkHostMediaDeviceInfo {
+  deviceId: string;
+  kind: 'audioinput' | 'videoinput';
+  label: string;
+  groupId?: string;
+}
+
+/**
+ * Normalized media track constraints sent to `hostCapabilities.media.getUserMedia()`.
+ */
+export interface InkHostMediaTrackConstraints {
+  deviceId?: string;
   sampleRate?: number;
-  /** Requested number of audio channels. */
-  numberOfChannels?: number;
-  /** Requested sample or container format, for example `pcm`. */
-  format?: string;
+  channelCount?: number;
+  echoCancellation?: boolean;
+  facingMode?: string;
+  width?: number;
+  height?: number;
+  frameRate?: number;
 }
 
 /**
- * Start request forwarded to `hostCapabilities.media.startAudioRecording()`.
+ * Request forwarded to `hostCapabilities.media.getUserMedia()`.
  */
-export interface InkHostStartAudioRecordingRequest {
-  /** Runtime-generated identifier for the recorder target receiving follow-up events. */
-  targetId: string;
-  /** Host recording options requested by the Ink app. */
-  options: InkHostAudioRecordingOptions;
+export interface InkHostGetUserMediaRequest {
+  streamId: string;
+  constraints: {
+    audio?: InkHostMediaTrackConstraints;
+    video?: InkHostMediaTrackConstraints;
+  };
+}
+
+/**
+ * Actual track settings reported back by the host after opening a media stream.
+ */
+export interface InkHostMediaTrackSettings extends InkHostMediaTrackConstraints {}
+
+/**
+ * Track descriptor returned from `hostCapabilities.media.getUserMedia()`.
+ */
+export interface InkHostMediaTrackDescriptor {
+  trackId: string;
+  kind: 'audio' | 'video';
+  label: string;
+  enabled?: boolean;
+  muted?: boolean;
+  settings: InkHostMediaTrackSettings;
+}
+
+/**
+ * Stream descriptor returned from `hostCapabilities.media.getUserMedia()`.
+ */
+export interface InkHostMediaStreamDescriptor {
+  streamId: string;
+  tracks: InkHostMediaTrackDescriptor[];
+}
+
+/**
+ * Control request forwarded to `hostCapabilities.media.stopMediaTrack()`.
+ */
+export interface InkHostMediaTrackControlRequest {
+  streamId: string;
+  trackId: string;
+}
+
+/**
+ * Request forwarded to `hostCapabilities.media.createMediaRecorder()`.
+ */
+export interface InkHostCreateMediaRecorderRequest {
+  recorderId: string;
+  streamId: string;
+  mimeType: string;
+}
+
+/**
+ * Result returned from `hostCapabilities.media.createMediaRecorder()`.
+ */
+export interface InkHostMediaRecorderDescriptor {
+  recorderId: string;
+  mimeType: string;
+}
+
+/**
+ * Control request forwarded to media-recorder host methods.
+ */
+export interface InkHostMediaRecorderControlRequest {
+  recorderId: string;
+}
+
+/**
+ * Start request forwarded to `hostCapabilities.media.startMediaRecorder()`.
+ */
+export interface InkHostMediaRecorderStartRequest extends InkHostMediaRecorderControlRequest {
+  timesliceMs?: number;
 }
 
 /**
@@ -855,14 +931,28 @@ export interface InkHostCapabilities {
   };
   /** Host implementations for recording audio and capturing still photos. */
   media?: {
-    /** Starts audio recording and later emits `media.audioRecording*` events. */
-    startAudioRecording?(request: InkHostStartAudioRecordingRequest): void | Promise<void>;
-    /** Stops the currently active audio recording session. */
-    stopAudioRecording?(request: Record<string, never>): void | Promise<void>;
-    /** Pauses the currently active audio recording session. */
-    pauseAudioRecording?(request: Record<string, never>): void | Promise<void>;
-    /** Resumes a previously paused audio recording session. */
-    resumeAudioRecording?(request: Record<string, never>): void | Promise<void>;
+    /** Lists the media devices currently exposed to Ink. */
+    enumerateDevices?(): InkHostMediaDeviceInfo[] | Promise<InkHostMediaDeviceInfo[]>;
+    /** Opens a host-backed audio/video stream and returns its actual track settings. */
+    getUserMedia?(
+      request: InkHostGetUserMediaRequest,
+    ): InkHostMediaStreamDescriptor | Promise<InkHostMediaStreamDescriptor>;
+    /** Stops one track previously returned by `getUserMedia()`. */
+    stopMediaTrack?(request: InkHostMediaTrackControlRequest): void | Promise<void>;
+    /** Creates a recorder session bound to a host media stream. */
+    createMediaRecorder?(
+      request: InkHostCreateMediaRecorderRequest,
+    ): InkHostMediaRecorderDescriptor | Promise<InkHostMediaRecorderDescriptor>;
+    /** Starts a host-created recorder session. */
+    startMediaRecorder?(request: InkHostMediaRecorderStartRequest): void | Promise<void>;
+    /** Pauses a host-created recorder session. */
+    pauseMediaRecorder?(request: InkHostMediaRecorderControlRequest): void | Promise<void>;
+    /** Resumes a host-created recorder session. */
+    resumeMediaRecorder?(request: InkHostMediaRecorderControlRequest): void | Promise<void>;
+    /** Requests one data flush from a host-created recorder session. */
+    requestMediaRecorderData?(request: InkHostMediaRecorderControlRequest): void | Promise<void>;
+    /** Stops a host-created recorder session. */
+    stopMediaRecorder?(request: InkHostMediaRecorderControlRequest): void | Promise<void>;
     /** Captures one photo and returns encoded image bytes plus their MIME type. */
     takePhoto?(
       request: InkHostTakePhotoOptions,