BiDi Commands and Events

The Mac2 driver has partial support of the WebDriver BiDi Protocol. It inherits the BiDi commands and events supported by the Appium base driver, and additionally defines the events and commands listed below.

Events

appium:mac2.nativeVideoRecordingChunkAdded

Indicates that a new native video recording chunk is available for consumption.

This event is continuously emitted as soon as the macos: startNativeScreenRecording execute method is invoked. Event emission stops as soon as the macos: stopNativeScreenRecording execute method is called, or the test session is stopped.

By subscribing to this event before starting the recording and passing ignorePayload: true to macos: stopNativeScreenRecording, clients can stream and append decoded video chunks directly to a local file without loading the entire recording into memory as a Base64 string.

Available since driver version 2.2.0.

Event Type (CDDL)

appium:mac2.nativeVideoRecordingChunkAdded = (
  method: "appium:mac2.nativeVideoRecordingChunkAdded",
  params: {
    uuid: text,
    payload: text,
  },
)

Parameter	Description
uuid	The UUID of the video being broadcast
payload	Base64-encoded chunk of the corresponding video file