Struct fidl_fuchsia_settings_policy::VolumePolicyControllerProxy

pub struct VolumePolicyControllerProxy { /* private fields */ }

Implementations

impl VolumePolicyControllerProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for VolumePolicyController

pub fn take_event_stream(&self) -> VolumePolicyControllerEventStream

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

Panics

Panics if the event stream was already taken.

pub fn get_properties(&self) -> QueryResponseFut<Vec<Property>>

Gets a list of volume policy properties, including possible transforms and active policies for the property.

pub fn add_policy( &self, target: &mut Target, parameters: &mut PolicyParameters ) -> QueryResponseFut<VolumePolicyControllerAddPolicyResult>

Adds a policy for the given target.

Returns a policy_id for the added policy, which can be used to remove the policy with RemovePolicy.

If the policy being added contradicts an existing policy, the add call will return an error. An example would be specifying a max volume for a stream that is lower than an existing min volume.

If the transform specified in the PolicyParameters is not enumerated in the available_transforms of the policy property, the connection will be closed.

Adding a policy will immediately adjust the audio setting values if they don’t yet conform to the policy, such as reducing the volume if it’s greater than a specified maximum volume.

pub fn remove_policy( &self, policy_id: u32 ) -> QueryResponseFut<VolumePolicyControllerRemovePolicyResult>

Removes a policy with the given policy id.

Any client of this API can remove policies set by any other client.

Trait Implementations

impl Clone for VolumePolicyControllerProxy

fn clone(&self) -> VolumePolicyControllerProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VolumePolicyControllerProxy

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

Formats the value using the given formatter.

impl Proxy for VolumePolicyControllerProxy

type Protocol = VolumePolicyControllerMarker

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 is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed<'a>(&'a self) -> OnSignals<'a>

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

impl VolumePolicyControllerProxyInterface for VolumePolicyControllerProxy

type GetPropertiesResponseFut = QueryResponseFut<Vec<Property, Global>>

fn get_properties(&self) -> Self::GetPropertiesResponseFut

type AddPolicyResponseFut = QueryResponseFut<Result<u32, Error>>

fn add_policy( &self, target: &mut Target, parameters: &mut PolicyParameters ) -> Self::AddPolicyResponseFut

type RemovePolicyResponseFut = QueryResponseFut<Result<(), Error>>

fn remove_policy(&self, policy_id: u32) -> Self::RemovePolicyResponseFut