Skip to main content
KeyOS API Reference

CameraApi

camera

Struct CameraApi 

Source 
pub struct CameraApi<P: CheckedPermissions>(/* private fields */);

Implementations§

Source§

impl<P: CheckedPermissions> CameraApi<P>

Source

pub fn try_new_with_timeout(timeout: Duration) -> Option<Self>

Permission: not needed

Source

pub fn subscribe<S>( &self, context: &mut ServerContext<S>, ) -> Result<(), SubscriptionError>
where S: Server + ScalarEventHandler<Frame>, P: MessageAllowed<Subscribe>,

Permission: os/camera / Subscribe

Permission group: peripherals.camera-use

Required signature: thirdParty

Approval: grantOnFirstUse

Start requesting camera frames. Cheap because the frames are not actually sent, but mirrored on the client side. The event is sent when a new frame is available.

Source

pub fn is_enabled(&self) -> bool
where P: MessageAllowed<IsEnabled>,

Permission: os/camera / IsEnabled

Permission group: peripherals.camera-status

Required signature: thirdParty

Approval: autoAllow

Source

pub fn is_in_use(&self) -> bool
where P: MessageAllowed<IsInUse>,

Permission: os/camera / IsInUse

Permission group: peripherals.camera-status

Required signature: thirdParty

Approval: autoAllow

Trait Implementations§

Source§

impl<P: Default + CheckedPermissions> Default for CameraApi<P>

Source§

fn default() -> CameraApi<P>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<P> Freeze for CameraApi<P>

§

impl<P> RefUnwindSafe for CameraApi<P>

§

impl<P> Send for CameraApi<P>

§

impl<P> Sync for CameraApi<P>

§

impl<P> Unpin for CameraApi<P>

§

impl<P> UnsafeUnpin for CameraApi<P>

§

impl<P> UnwindSafe for CameraApi<P>

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
§

impl<T> Pointee for T

§

type Metadata = ()

The metadata type for pointers and references to this type.
§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.