class Stream
Defined at line 3208 of file fidling/gen/sdk/fidl/fuchsia.camera3/fuchsia.camera3/hlcpp/fuchsia/camera3/cpp/fidl.h
A Stream represents timing, sequencing, and other camera-specific properties applied to a buffer
collection.
Public Methods
void ~Stream ()void GetProperties (GetPropertiesCallback callback)Gets the properties associated with this stream. The value returned is identical to the one
corresponding to this stream as returned by |Device.GetConfigurations|.
void GetProperties2 (GetProperties2Callback callback)Gets the properties associated with this stream. The value returned is identical to the one
corresponding to this stream as returned by |Device.GetConfigurations|.
void SetCropRegion (::std::unique_ptr< ::fuchsia::math::RectF> region)Sets the Stream's crop region to the provided region, with the top-left of the image
represented by (0,0) and the bottom-right of the image represented by (1,1). The resulting
content is subsequently scaled to fill the output buffer. If the implementation does not
precisely support the provided value, it will be expanded to the minimum region that covers
the provided region. If region is set to null, the crop region is unset, which is equivalent
to specifying a region covering the entire image. Upon initial connection, the region is
unset. If the stream does not support crop region, the connection is closed with the
ZX_ERR_NOT_SUPPORTED epitaph.
void WatchCropRegion (WatchCropRegionCallback callback)Returns the crop region if it has changed from a previously returned value, or is called by
a client for the first time. Frame callbacks received after receiving this callback reflect
the use of the new region. See SetCropRegion for a description of the region parameter.
void SetResolution (::fuchsia::math::Size coded_size)Sets the resolution of the stream to the provided value. If the implementation does not
precisely support the provided value, it will be expanded to the minimum resolution that
exceeds the provided resolution.
void WatchResolution (WatchResolutionCallback callback)Returns the resolution if it has changed from a previously returned value, or is called by
a client for the first time. Frame callbacks received after receiving this callback reflect
the new resolution.
void SetBufferCollection2 (::fidl::InterfaceHandle< ::fuchsia::sysmem2::BufferCollectionToken> token)If non-null, requests renegotiation of the buffer collection backing this stream, and
identifies this client as a participant in buffer negotiation. If null, identifies this
client as a non-participant in buffer negotiation. Upon initial connection, the client is a
non-participant. After registering as a participant, clients must always have an outstanding
call to WatchBufferCollection to receive tokens from the server so that they are able to
respond to current and future renegotiation requests.
void SetBufferCollection (::fidl::InterfaceHandle< ::fuchsia::sysmem::BufferCollectionToken> token)void WatchBufferCollection2 (WatchBufferCollection2Callback callback)Returns when the server or any buffer negotiation participant (including the current client)
requires buffer renegotiation, and the current client is registered as a participant. Frame
callbacks received after receiving this callback apply to the newly negotiated collection.
Because the camera can output directly to these collections, each client should support
reading from a |fuchsia.sysmem.CoherencyDomain| of RAM, and set |ram_domain_supported| in
their |fuchsia.sysmem.BufferMemoryConstraints|.
void WatchBufferCollection (WatchBufferCollectionCallback callback)void WatchOrientation (WatchOrientationCallback callback)Returns the orientation if it has changed from a previously returned value, or is called by
a client for the first time. Frame callbacks received after receiving this callback reflect
the new orientation.
void GetNextFrame (GetNextFrameCallback callback)See GetNextFrame2.
void GetNextFrame2 (GetNextFrame2Callback callback)Request the next available frame for this stream that has not yet been acquired by the
current client. Multiple participating clients may concurrently hold the same frame. Returns
when the stream has completed populating the buffer and may be read by the client, provided
the number of unreleased buffers is less than the count provided via the most recently
negotiated buffer collection token. If a buffer renegotiation is in progress, this call will
return only after the negotiation is complete and a new collection is available.
void Rebind (::fidl::InterfaceRequest< ::fuchsia::camera3::Stream> request)Request another connection to this Stream. This allows a client to delegate different
operations to different coordinated clients, or have multiple clients concurrently observe
frames produced by the stream.