API-Referenz

Bildschirm-Spiegelung

Funktionsunterstützung über app.capabilities prüfen, Autorisierung über app.access und Host-Berechtigungen. Die Beispiele verwenden synthetische Werte; vor dem Aufruf Pfade, IDs, Eingaben und Filter ersetzen.

Typdefinitionen

graphql
type Subscription {
  screenMirrorState: MirrorState!
  screenMirrorVideoCodec: MirrorCodecConfiguration
  screenMirrorAudioGranted: Boolean!
}

type Mutation {
  openAccessibilitySettings: Boolean!
  requestScreenMirrorAudio: Boolean!
  requestScreenMirrorKeyFrame: Boolean!
  startScreenMirror(audio: Boolean!): Boolean!
  stopScreenMirror: Boolean!
  updateScreenMirrorQuality(mode: ScreenMirrorMode!): Boolean!
}

type Query {
  isScreenMirroring: Boolean!
  screenMirrorControlEnabled: Boolean!
  screenMirrorQuality: ScreenMirrorQuality!
  screenMirrorVideoCodec: ScreenMirrorVideoCodec
}

type MirrorCodecConfiguration {
	annexB: String!
}

type MirrorState {
	running: Boolean!
}

enum ScreenMirrorMode {
	HD
	SMOOTH
}

type ScreenMirrorQuality {
	mode: ScreenMirrorMode!
	resolution: Int!
}

type ScreenMirrorVideoCodec {
	
	annexB: String!
	
	keyFrame: String
}

Operationen

subscription

screenMirrorState

Liest den aktuellen Zustand der Bildschirmspiegelung.

graphql
subscription screenMirrorState {
  screenMirrorState { running }
}
subscription

screenMirrorVideoCodec

Aktualisierungen der Videocodec-Konfiguration der Bildschirmspiegelung empfangen.

graphql
subscription screenMirrorVideoCodec {
  screenMirrorVideoCodec { annexB }
}
subscription

screenMirrorAudioGranted

Empfängt die Benachrichtigung über eine erteilte Audioberechtigung zur Bildschirmspiegelung.

graphql
subscription screenMirrorAudioGranted {
  screenMirrorAudioGranted
}
mutation

openAccessibilitySettings

Öffnet die Android-Einstellungen für Bedienungshilfen auf dem Gerät. Erforderlich, bevor sendScreenMirrorControl Gesten ausführen kann.

graphql
mutation openAccessibilitySettings {
  openAccessibilitySettings
}
mutation

requestScreenMirrorAudio

Fordert die Mikrofonberechtigung für Bildschirmspiegelungsaudio an. Liefert true, falls bereits erteilt, sonst false und öffnet einen Berechtigungsdialog.

graphql
# Returns false when the device has not granted RECORD_AUDIO yet; the
# platform asks for it and the caller retries.
mutation requestScreenMirrorAudio {
  requestScreenMirrorAudio
}
mutation

requestScreenMirrorKeyFrame

Fordert einen neuen Schlüsselframe vom aktiven Videoencoder der Bildschirmspiegelung an.

graphql
mutation requestScreenMirrorKeyFrame {
  requestScreenMirrorKeyFrame
}
mutation

startScreenMirror

Startet die Bildschirmspiegelung. audio=true überträgt auch Geräteaudio und erfordert RECORD_AUDIO.

graphql
mutation startScreenMirror($audio: Boolean!) {
  startScreenMirror(audio: $audio)
}
mutation

stopScreenMirror

Stoppt die aktive Bildschirmspiegelung.

graphql
mutation stopScreenMirror {
  stopScreenMirror
}
mutation

updateScreenMirrorQuality

Legt die Qualitätsvoreinstellung der Bildschirmspiegelung fest.

graphql
mutation updateScreenMirrorQuality($mode: ScreenMirrorMode!) {
  updateScreenMirrorQuality(mode: $mode)
}
query

isScreenMirroring

Prüft, ob eine Bildschirmspiegelung aktiv ist.

graphql
query isScreenMirroring {
  isScreenMirroring
}
query

screenMirrorControlEnabled

Liefert true, wenn der PlainApp-Bedienungshilfendienst aktiviert ist und Gesten ausführen kann.

graphql
query screenMirrorControlEnabled {
  screenMirrorControlEnabled
}
query

screenMirrorQuality

Liest die aktuelle Qualitätsvoreinstellung der Bildschirmspiegelung.

graphql
query screenMirrorQuality {
  screenMirrorQuality { mode resolution }
}
query

screenMirrorVideoCodec

Liest den Videocodec der aktuellen oder letzten Spiegelungssitzung.

graphql
# Null while the pipeline has not published its codec configuration.
query screenMirrorVideoCodec {
  screenMirrorVideoCodec { annexB keyFrame }
}