MusicPlayerClient

termusiclib::player::music_player_client

Struct MusicPlayerClient 

Source 
pub struct MusicPlayerClient<T> { /* private fields */ }

Implementations§

Source§

impl MusicPlayerClient<Channel>

Source

pub async fn connect<D>(dst: D) -> Result<Self, Error>
where D: TryInto<Endpoint>, D::Error: Into<StdError>,

Attempt to create a new client by connecting to a given endpoint.

Source§

impl<T> MusicPlayerClient<T>
where T: GrpcService<Body>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

Source

pub fn new(inner: T) -> Self

Source

pub fn with_origin(inner: T, origin: Uri) -> Self

Source

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> MusicPlayerClient<InterceptedService<T, F>>
where F: Interceptor, T::ResponseBody: Default, T: Service<Request<Body>, Response = Response<<T as GrpcService<Body>>::ResponseBody>>, <T as Service<Request<Body>>>::Error: Into<StdError> + Send + Sync,

Source

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

Source

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

Source

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

Source

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

Source

pub async fn toggle_pause( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<PlayState>, Status>

Player Commands Toggle Pause/Play, returns the new state

Source

pub async fn skip_next( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<Empty>, Status>

Source

pub async fn skip_previous( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<Empty>, Status>

Source

pub async fn get_progress( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<GetProgressResponse>, Status>

Source

pub async fn volume_up( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<VolumeReply>, Status>

Source

pub async fn volume_down( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<VolumeReply>, Status>

Source

pub async fn speed_up( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<SpeedReply>, Status>

Source

pub async fn speed_down( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<SpeedReply>, Status>

Source

pub async fn toggle_gapless( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<GaplessState>, Status>

Toggle the gapless mdoe, returns the new state.

Source

pub async fn seek_forward( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<PlayerTime>, Status>

Source

pub async fn seek_backward( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<PlayerTime>, Status>

Source

pub async fn play_specific( &mut self, request: impl IntoRequest<PlaylistPlaySpecific>, ) -> Result<Response<Empty>, Status>

Playlist Commands Skip to a specific track in the playlist at the momemnt, the one set via “current_track_index”

Source

pub async fn cycle_loop( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<PlaylistLoopMode>, Status>

Cycle the playlist loop mode, returns the new mode.

Source

pub async fn add_to_playlist( &mut self, request: impl IntoRequest<PlaylistTracksToAdd>, ) -> Result<Response<Empty>, Status>

Add one or multiple tracks to the playlist

Source

pub async fn remove_from_playlist( &mut self, request: impl IntoRequest<PlaylistTracksToRemove>, ) -> Result<Response<Empty>, Status>

Remove one or multiple tracks from the playlist

Source

pub async fn swap_tracks( &mut self, request: impl IntoRequest<PlaylistSwapTracks>, ) -> Result<Response<Empty>, Status>

Swap some tracks.

Source

pub async fn get_playlist( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<PlaylistTracks>, Status>

Get all tracks of the playlist.

Source

pub async fn shuffle_playlist( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<Empty>, Status>

Shuffle the playlist, returns the new playlist tracks.

Source

pub async fn remove_deleted_tracks( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<Empty>, Status>

Check for and remove deleted items from the playlist. Unlike shuffle, this will send Removal events

Source

pub async fn reload_config( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<Empty>, Status>

Misc Commands

Source

pub async fn subscribe_server_updates( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<Streaming<StreamUpdates>>, Status>

Trait Implementations§

Source§

impl<T: Clone> Clone for MusicPlayerClient<T>

Source§

fn clone(&self) -> MusicPlayerClient<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for MusicPlayerClient<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for MusicPlayerClient<T>

§

impl<T> RefUnwindSafe for MusicPlayerClient<T>
where T: RefUnwindSafe,

§

impl<T> Send for MusicPlayerClient<T>
where T: Send,

§

impl<T> Sync for MusicPlayerClient<T>
where T: Sync,

§

impl<T> Unpin for MusicPlayerClient<T>
where T: Unpin,

§

impl<T> UnwindSafe for MusicPlayerClient<T>
where T: UnwindSafe,

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> 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