Skip to main content

ShareRecordingRequest

Struct ShareRecordingRequest 

Source
pub struct ShareRecordingRequest {
    pub recording_source_id: String,
    pub visibility: ShareVisibility,
    pub invited_emails: Option<Vec<String>>,
    pub party_masking: Option<PartyMasking>,
    pub show_transcript: Option<bool>,
    pub show_audio: Option<bool>,
    pub allow_download: Option<bool>,
    pub default_mute_local: Option<bool>,
    pub default_mute_remote: Option<bool>,
    pub password: Option<String>,
    pub expires_at: Option<String>,
}
Expand description

Body of POST /api/voice/recordings/{id}/share — create or update a recording’s share. The recording must already be synced (metadata + bytes) or the platform returns 404.

Fields§

§recording_source_id: String

The artifact UUID, as synced (daemon-side artifacts.id). Goes in the URL path; carried in the struct so callers pass one value.

§visibility: ShareVisibility§invited_emails: Option<Vec<String>>

Restricted tier — the WaveKat-account emails allowed to open the share. Ignored (and omitted) for Private / Public.

§party_masking: Option<PartyMasking>

Per-share visibility controls (platform docs/14) — what a viewer may see. Each is omitted when unset; the platform then applies its privacy-forward default (identity masked, transcript hidden, audio shown, download off). NB the platform treats the request as the full desired state, so an omitted control is reset to its default, not preserved from a prior share — send all of them when editing an existing share’s controls.

§show_transcript: Option<bool>§show_audio: Option<bool>§allow_download: Option<bool>

Whether a viewer may download the WAV, distinct from hearing it. Off by default and only meaningful while show_audio is true — the platform forces it off otherwise (you can’t save what you can’t hear). A soft control: it hides the viewer’s Download affordance, not the bytes a listener already fetches to play.

§default_mute_local: Option<bool>

Per-channel playback defaults — which side is audible by default in the viewer’s player (docs/14). A call has two channels: local (the owner’s microphone, “your side”) and remote (the other party, “their side”). true means that side starts muted; the viewer can still un-mute it, and the audio file is unchanged — this is only the player’s starting state. Each is omitted when unset, in which case the platform defaults to audible (false). Only meaningful while show_audio is true; ignored when audio is hidden.

§default_mute_remote: Option<bool>§password: Option<String>

Phase 2 — out-of-band password gate. Omitted when unset.

§expires_at: Option<String>

Phase 2 — RFC 3339 auto-revoke time. Omitted when unset.

Trait Implementations§

Source§

impl Clone for ShareRecordingRequest

Source§

fn clone(&self) -> ShareRecordingRequest

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ShareRecordingRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ShareRecordingRequest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ShareRecordingRequest

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more