CaptureService

Mostrar obsoleto

*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Não criável
Serviço

CaptureService é um serviço do lado do cliente que permite que os desenvolvedores controlem como a funcionalidade de captura de captura de tela se integra às suas experiências.Pode ser usado para incluir momentos predefinidos em que um screenshot é automaticamente capturado para um usuário e esse usuário pode então salvar, compartilhar ou excluir o screenshot.

Resumo

Métodos

Eventos

Propriedades

Métodos

CaptureScreenshot

()

Este método captura uma captura de tela para o usuário, mas não a salva imediatamente em sua galeria Capturas dentro do menu principal da experiência.Em vez disso, um temporário contentId é criado para identificar a nova capturar.

O retorno de chamada onCaptureReady pode ser usado para solicitar ao usuário que salve ou compartilhe a captura de tela:


local CaptureService = game:GetService("CaptureService")
-- Referência a um ImageLabel pai do script que contém este código
local imageLabel = script.Parent
local function onCaptureReady(contentId)
imageLabel.Image = contentId
end
CaptureService:CaptureScreenshot(onCaptureReady)

Parâmetros

onCaptureReady: function

Uma função de retorno que é chamada com o contentId da nova captura assim que estiver pronta.

Valor Padrão: ""

Devolução

()

PromptSaveCapturesToGallery

()

Este método solicita ao usuário que salve os instantâneos de tela identificados pelo fornecido contentIds em sua galeria Capturas dentro do menu principal da experiência

Parâmetros

captures: Array
Valor Padrão: ""
resultCallback: function

Uma função de retorno que será invocada com um dicionário que mapeia cada contentId para um booleano que indica se o usuário aceitou salvar essa capturar.

Valor Padrão: ""

Devolução

()

PromptShareCapture

()

Este método solicita ao usuário que compartilhe a captura de tela identificada pelo fornecido contentId usando a folha de compartilhamento nativa em seu dispositivo.

A imagem de captura é compartilhada junto com um link de convite para a experiência quando suportada.Nem todos os dispositivos suportam incluir tanto uma captura de tela quanto um víncular / conectarde convite.

O launchData estará disponível no campo launchData para usuários que se juntam através do víncular / conectarde convite.

Para evitar um erro ao chamar este método, primeiro chame PolicyService:GetPolicyInfoForPlayerAsync() e verifique se IsContentSharingAllowed é verdadeiro no dicionário retornado.

Parâmetros

captureContent: Content
Valor Padrão: ""
launchData: string

Uma string opcional para incluir como dados de lançamento no víncular / conectarde convite.

Valor Padrão: ""
onAcceptedCallback: function

Uma função de retorno opcional invocada se o usuário aceitar compartilhar.

Valor Padrão: ""
onDeniedCallback: function

Uma função de retorno opcional invocada se o usuário negar a partilha.

Valor Padrão: ""

Devolução

()

TakeCapture

()

Parâmetros

onCaptureReady: function
Valor Padrão: ""
captureParams: Dictionary
Valor Padrão: "nil"

Devolução

()

Eventos

CaptureBegan

Este evento dispara imediatamente antes que uma nova captura de captura de tela seja feita.Pode ser usado para personalizar a experiência de captura, por exemplo, ao ocultar certos elementos de GUI.


CaptureEnded

Este evento é disparado após a conclusão de uma nova captura de captura de tela. Ele pode ser usado para restaurar quaisquer alterações feitas quando o evento CaptureBegan foi disparado.


UserCaptureSaved

Este evento é disparado quando o usuário salva uma captura de tela usando a interface de captura de captura de tela do Roblox.Pode ser usado para análise ou para solicitar que o usuário compartilhe sua capturar.

Parâmetros

captureContentId: ContentId

O contentId identificando a captura de tela que o usuário salvou.