Struct fidl_fuchsia_ui_composition_internal::ScreenCaptureProxy

pub struct ScreenCaptureProxy { /* private fields */ }

Implementations

impl ScreenCaptureProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.ui.composition.internal/ScreenCapture.

pub fn take_event_stream(&self) -> ScreenCaptureEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn configure( &self, payload: ScreenCaptureConfig ) -> QueryResponseFut<ScreenCaptureConfigureResult>

Clients should first use the [‘fuchsia.ui.composition/Allocator’] protocol to register a BufferCollection.

Similarly, the clients are responsible for specifying a buffer big enough for the image. If the buffer is too small, an attempt will be made to render the image, however, it will not be guaranteed to contain the complete image.

pub fn get_next_frame( &self ) -> QueryResponseFut<ScreenCaptureGetNextFrameResult>

[GetNextFrame] returns the latest unseen-by-the-client frame as soon as possible. On the first call to [GetNextFrame] and any subsequent calls that have not recieved the previous expected requested frame, [GetNextFrame] will return immediately with the last frame to be rendered. If the client had requested the previous frame, the server will wait until the next frame is produced to return.

After the client finishes processing the returned buffer, they should drop the eventpair to signal to the server that the buffer can be re-used.

It is invalid to call [GetNextFrame] while a previous call is still pending. Doing so will return a BAD_HANGING_GET error and cause the channel to close.

Trait Implementations

impl Clone for ScreenCaptureProxy

fn clone(&self) -> ScreenCaptureProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScreenCaptureProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Proxy for ScreenCaptureProxy

type Protocol = ScreenCaptureMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.

impl ScreenCaptureProxyInterface for ScreenCaptureProxy

type ConfigureResponseFut = QueryResponseFut<Result<(), ScreenCaptureError>>

fn configure(&self, payload: ScreenCaptureConfig) -> Self::ConfigureResponseFut

type GetNextFrameResponseFut = QueryResponseFut<Result<FrameInfo, ScreenCaptureError>>

fn get_next_frame(&self) -> Self::GetNextFrameResponseFut