PlainApp
Referência da API

Duplicação de ecrã

Verificar app.capabilities para o suporte de funcionalidades e app.access juntamente com as permissões do anfitrião para autorização. Os exemplos usam valores sintéticos; substituir caminhos, ID, entradas e filtros antes da chamada.

Definições de Tipo

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
}

Operações

subscription

screenMirrorState

Consultar o estado atual da duplicação de ecrã.

graphql
subscription screenMirrorState {
  screenMirrorState { running }
}
subscription

screenMirrorVideoCodec

Receber atualizações da configuração do codec de vídeo da sessão de espelhamento de tela.

graphql
subscription screenMirrorVideoCodec {
  screenMirrorVideoCodec { annexB }
}
subscription

screenMirrorAudioGranted

Receber uma notificação de concessão da permissão de áudio da duplicação de ecrã.

graphql
subscription screenMirrorAudioGranted {
  screenMirrorAudioGranted
}
mutation

openAccessibilitySettings

Abrir o ecrã de definições de Acessibilidade do Android no dispositivo. Necessário antes de sendScreenMirrorControl poder enviar gestos.

graphql
mutation openAccessibilitySettings {
  openAccessibilitySettings
}
mutation

requestScreenMirrorAudio

Solicitar a permissão do microfone para o áudio da duplicação de ecrã. Devolve true se já concedida, caso contrário false e abre uma caixa de diálogo de permissão.

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

Solicitar um novo fotograma-chave ao codificador de vídeo ativo da duplicação de ecrã.

graphql
mutation requestScreenMirrorKeyFrame {
  requestScreenMirrorKeyFrame
}
mutation

startScreenMirror

Iniciar uma sessão de duplicação de ecrã. Usar audio=true para transmitir também o áudio do dispositivo (exige a permissão RECORD_AUDIO).

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

stopScreenMirror

Parar a sessão ativa de duplicação de ecrã.

graphql
mutation stopScreenMirror {
  stopScreenMirror
}
mutation

updateScreenMirrorQuality

Definir a predefinição de qualidade da duplicação de ecrã.

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

isScreenMirroring

Verificar se há uma sessão de duplicação de ecrã ativa.

graphql
query isScreenMirroring {
  isScreenMirroring
}
query

screenMirrorControlEnabled

Devolve true quando o serviço de Acessibilidade do PlainApp está ativado e pode enviar gestos.

graphql
query screenMirrorControlEnabled {
  screenMirrorControlEnabled
}
query

screenMirrorQuality

Obter a predefinição de qualidade atual da duplicação.

graphql
query screenMirrorQuality {
  screenMirrorQuality { mode resolution }
}
query

screenMirrorVideoCodec

Obter o codec de vídeo utilizado pela sessão de duplicação atual ou pela última sessão.

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