Struct MicrophoneEffects 

pub struct MicrophoneEffects<'a, 'b, S: AppState> { /* private fields */ }

Convenience builder for standard microphone host capabilities.

Implementations

impl<'a, 'b, S: AppState> MicrophoneEffects<'a, 'b, S>

pub fn availability(self) -> EffectBuilder<'a, 'b, S>

Queries microphone permission and available input devices.

Use this before showing recording controls. The result tells the app whether microphone permission is granted and which host input devices are visible.

pub fn request_permission( self, request: MicrophonePermissionRequest, ) -> EffectBuilder<'a, 'b, S>

Requests microphone permission from the host.

request.reason can be used by hosts that support a product-specific rationale before the platform prompt. The success action receives the resulting MicrophonePermission state.

pub fn capture_audio( self, request: MicrophoneCaptureRequest, ) -> EffectBuilder<'a, 'b, S>

Captures bounded audio from the selected microphone.

request.duration_ms must define the intended capture length. Optional sample rate, channel count, and sample format let the host choose the closest supported recording configuration.

pub fn cancel_capture(self) -> EffectBuilder<'a, 'b, S>

Cancels an active microphone capture session.

Use this when the user stops recording, closes the screen, or chooses a different input path before the bounded capture completes.