class StreamOutputConstraints
Defined at line 11343 of file fidling/gen/sdk/fidl/fuchsia.media/fuchsia.media/cpp/fidl/fuchsia.media/cpp/natural_types.h
The stream-processor-controlled output configuration, including both
StreamBufferConstraints for the output and FormatDetails for the output.
Public Methods
void StreamOutputConstraints (Storage_ storage)
void StreamOutputConstraints ()
Defined at line 11348 of file fidling/gen/sdk/fidl/fuchsia.media/fuchsia.media/cpp/fidl/fuchsia.media/cpp/natural_types.h
void StreamOutputConstraints (StreamOutputConstraints && )
Defined at line 11349 of file fidling/gen/sdk/fidl/fuchsia.media/fuchsia.media/cpp/fidl/fuchsia.media/cpp/natural_types.h
void StreamOutputConstraints (const StreamOutputConstraints & other)
StreamOutputConstraints & operator= (StreamOutputConstraints && )
Defined at line 11350 of file fidling/gen/sdk/fidl/fuchsia.media/fuchsia.media/cpp/fidl/fuchsia.media/cpp/natural_types.h
StreamOutputConstraints & operator= (const StreamOutputConstraints & other)
bool operator== (const StreamOutputConstraints & other)
bool operator!= (const StreamOutputConstraints & other)
bool IsEmpty ()
const std::optional<uint64_t> & stream_lifetime_ordinal ()
A client which always immediately re-configures output buffers on
receipt of OnOutputConstraints() with buffer_constraints_action_required
true can safely ignore this field.
A client is permitted to ignore an OnOutputConstraints() message even with
buffer_constraints_action_required true if the client knows the server
has already been told to discard the remainder of the stream with the
same stream_lifetime_ordinal or if this stream_lifetime_ordinal field is
set to 0. The server is required to re-send needed output config via
OnOutputConstraints() with new stream_lifetime_ordinal and
buffer_constraints_action_required true, if the most recent completed
server-side output config isn't what the server wants/needs yet for the
new stream.
::std::optional<uint64_t> & stream_lifetime_ordinal ()
A client which always immediately re-configures output buffers on
receipt of OnOutputConstraints() with buffer_constraints_action_required
true can safely ignore this field.
A client is permitted to ignore an OnOutputConstraints() message even with
buffer_constraints_action_required true if the client knows the server
has already been told to discard the remainder of the stream with the
same stream_lifetime_ordinal or if this stream_lifetime_ordinal field is
set to 0. The server is required to re-send needed output config via
OnOutputConstraints() with new stream_lifetime_ordinal and
buffer_constraints_action_required true, if the most recent completed
server-side output config isn't what the server wants/needs yet for the
new stream.
StreamOutputConstraints & stream_lifetime_ordinal (std::optional<uint64_t> value)
A client which always immediately re-configures output buffers on
receipt of OnOutputConstraints() with buffer_constraints_action_required
true can safely ignore this field.
A client is permitted to ignore an OnOutputConstraints() message even with
buffer_constraints_action_required true if the client knows the server
has already been told to discard the remainder of the stream with the
same stream_lifetime_ordinal or if this stream_lifetime_ordinal field is
set to 0. The server is required to re-send needed output config via
OnOutputConstraints() with new stream_lifetime_ordinal and
buffer_constraints_action_required true, if the most recent completed
server-side output config isn't what the server wants/needs yet for the
new stream.
const std::optional<bool> & buffer_constraints_action_required ()
When the buffer constraints are delivered, they indicate whether action
is required. A false value here permits delivery of constraints which
are fresher without forcing a buffer reconfiguration. If this is false,
a client cannot assume that it's safe to immediately re-configure output
buffers. If this is true, the client can assume it's safe to
immediately configure output buffers once.
A client is permitted to ignore buffer constraint versions which have
buffer_constraints_action_required false. The server is not permitted
to change buffer_constraints_action_required from false to true for the
same buffer_constraints_version_ordinal.
For each configuration, a client must use new buffers, never buffers
that were previously used for anything else, and never buffers
previously used for any other StreamProcessor purposes. This rule
exists for multiple good reasons, relevant to both mid-stream changes,
and changes on stream boundaries. A client should just use new buffers
each time.
When this is true, the server has already de-refed as many low-level
output buffers as the server can while still performing efficient
transition to the new buffers and will de-ref the rest asap. A Sync()
is not necessary to achieve non-overlap of resource usage to the extent
efficiently permitted by the formats involved.
If buffer_constraints_action_required is true, the server _must_ not
deliver more output data until after output buffers have been configured
(or re-configured) by the client.
::std::optional<bool> & buffer_constraints_action_required ()
When the buffer constraints are delivered, they indicate whether action
is required. A false value here permits delivery of constraints which
are fresher without forcing a buffer reconfiguration. If this is false,
a client cannot assume that it's safe to immediately re-configure output
buffers. If this is true, the client can assume it's safe to
immediately configure output buffers once.
A client is permitted to ignore buffer constraint versions which have
buffer_constraints_action_required false. The server is not permitted
to change buffer_constraints_action_required from false to true for the
same buffer_constraints_version_ordinal.
For each configuration, a client must use new buffers, never buffers
that were previously used for anything else, and never buffers
previously used for any other StreamProcessor purposes. This rule
exists for multiple good reasons, relevant to both mid-stream changes,
and changes on stream boundaries. A client should just use new buffers
each time.
When this is true, the server has already de-refed as many low-level
output buffers as the server can while still performing efficient
transition to the new buffers and will de-ref the rest asap. A Sync()
is not necessary to achieve non-overlap of resource usage to the extent
efficiently permitted by the formats involved.
If buffer_constraints_action_required is true, the server _must_ not
deliver more output data until after output buffers have been configured
(or re-configured) by the client.
StreamOutputConstraints & buffer_constraints_action_required (std::optional<bool> value)
When the buffer constraints are delivered, they indicate whether action
is required. A false value here permits delivery of constraints which
are fresher without forcing a buffer reconfiguration. If this is false,
a client cannot assume that it's safe to immediately re-configure output
buffers. If this is true, the client can assume it's safe to
immediately configure output buffers once.
A client is permitted to ignore buffer constraint versions which have
buffer_constraints_action_required false. The server is not permitted
to change buffer_constraints_action_required from false to true for the
same buffer_constraints_version_ordinal.
For each configuration, a client must use new buffers, never buffers
that were previously used for anything else, and never buffers
previously used for any other StreamProcessor purposes. This rule
exists for multiple good reasons, relevant to both mid-stream changes,
and changes on stream boundaries. A client should just use new buffers
each time.
When this is true, the server has already de-refed as many low-level
output buffers as the server can while still performing efficient
transition to the new buffers and will de-ref the rest asap. A Sync()
is not necessary to achieve non-overlap of resource usage to the extent
efficiently permitted by the formats involved.
If buffer_constraints_action_required is true, the server _must_ not
deliver more output data until after output buffers have been configured
(or re-configured) by the client.
const std::optional< ::fuchsia_media::StreamBufferConstraints> & buffer_constraints ()
::std::optional< ::fuchsia_media::StreamBufferConstraints> & buffer_constraints ()
StreamOutputConstraints & buffer_constraints (std::optional< ::fuchsia_media::StreamBufferConstraints> value)
Setter for buffer_constraints.
void StreamOutputConstraints (::fidl::internal::DefaultConstructPossiblyInvalidObjectTag )
Friends
class MemberVisitor
class NaturalTableCodingTraits