Struct AudioPlayerButton 

pub struct AudioPlayerButton { /* private fields */ }

A button that plays a recording and stops it, with its progress and, when there is one, a transcript to open. Space and Enter work on the button, as on any.

The app delivers the audio as a SoundClip. It can do it later: with Self::on_request, the first press asks for it and playing starts when it arrives.

It plays through Sound::speak_clip, so a new recording or anything else said by the Sound takes its place, and this button goes back to rest. Progress is by the clock, as the service does not report where it is. The sound does not stop by itself if the view leaves the screen while playing.

use ravenrs_widgets::{AudioPlayerButton, SoundClip, Ui};

let audio = AudioPlayerButton::new()
    .clip(SoundClip::new(vec![0.0; 44_100], 44_100))
    .transcript("Your order is ready.");
let mut ui = Ui::new(audio, ravenrs_style::Theme::raven_dark());
ui.update();

Implementations

impl AudioPlayerButton

pub fn new() -> Self

A player with nothing to play yet.

pub fn clip(self, clip: SoundClip) -> Self

The recording.

pub fn seconds(self, seconds: f32) -> Self

How long it lasts, to show before the recording arrives.

pub fn loading(self, loading: bool) -> Self

Whether the recording is on its way, which holds the button until it arrives.

pub fn on_request(self, handler: impl Fn() + 'static) -> Self

Called when someone presses play with no recording here: the app brings it, and it plays when it arrives through Self::clip. Without this or a clip, the button stays disabled.

pub fn transcript(self, text: impl Into<String>) -> Self

What was said, under a button that shows and hides it. Blank text says there is no speech in the recording.

pub fn on_transcribe(self, handler: impl Fn() + 'static) -> Self

With no transcript, offers a button that asks for one.

pub fn transcribing(self, transcribing: bool) -> Self

Whether a transcript is on its way, which holds that button.

pub fn transcript_open(self, open: Binding<bool>) -> Self

Keeps whether the transcript is open in the app’s hands. By default it starts closed and is kept here.

Trait Implementations

impl Clone for AudioPlayerButton

fn clone(&self) -> AudioPlayerButton

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioPlayerButton

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

Formats the value using the given formatter.

impl Default for AudioPlayerButton

fn default() -> AudioPlayerButton

Returns the “default value” for a type.

impl View for AudioPlayerButton

fn build(&self, cx: &mut BuildCx<'_>) -> NodeId

Creates this view’s node for the current build.

fn type_name(&self) -> &'static str

The name the diagnostics panel shows this view’s cost under.