Struct LiveTextInteraction 

pub struct LiveTextInteraction { /* private fields */ }

Wraps the VisionKit image analysis overlay view counterpart.

Implementations

impl LiveTextInteraction

pub fn new() -> Result<Self, VisionKitError>

Creates the VisionKit LiveTextInteraction wrapper.

pub fn with_delegate( delegate: &LiveTextInteractionDelegate, ) -> Result<Self, VisionKitError>

Creates the VisionKit live text interaction wrapper with the provided delegate.

pub fn set_analysis( &self, analysis: &ImageAnalysis, ) -> Result<(), VisionKitError>

Sets the VisionKit analysis value.

pub fn track_image_at_path<P: AsRef<Path>>( &self, path: P, ) -> Result<(), VisionKitError>

Tracks the image at path for the VisionKit live text interaction.

pub fn delegate( &self, ) -> Result<Option<LiveTextInteractionDelegate>, VisionKitError>

Returns the VisionKit delegate value.

pub fn set_delegate( &self, delegate: Option<&LiveTextInteractionDelegate>, ) -> Result<(), VisionKitError>

Sets the VisionKit delegate value.

pub fn preferred_interaction_types( &self, ) -> Result<LiveTextInteractionTypes, VisionKitError>

Returns the VisionKit preferred interaction types value.

pub fn set_preferred_interaction_types( &self, interaction_types: LiveTextInteractionTypes, ) -> Result<(), VisionKitError>

Sets the VisionKit preferred interaction types value.

pub fn active_interaction_types( &self, ) -> Result<LiveTextInteractionTypes, VisionKitError>

Returns the VisionKit active interaction types value.

pub fn selectable_items_highlighted(&self) -> Result<bool, VisionKitError>

Returns the VisionKit selectable items highlighted value.

pub fn set_selectable_items_highlighted( &self, value: bool, ) -> Result<(), VisionKitError>

Sets the VisionKit selectable items highlighted value.

pub fn tracking_image_view( &self, ) -> Result<Option<LiveTextTrackingImageView>, VisionKitError>

Returns the VisionKit tracking image view value.

pub fn set_tracking_image_view( &self, view: Option<&LiveTextTrackingImageView>, ) -> Result<(), VisionKitError>

Sets the VisionKit tracking image view value.

pub fn has_active_text_selection(&self) -> Result<bool, VisionKitError>

Returns whether VisionKit reports active text selection.

pub fn reset_selection(&self) -> Result<(), VisionKitError>

Resets the VisionKit selection state.

pub fn text(&self) -> Result<String, VisionKitError>

Returns the VisionKit text value.

pub fn selected_text(&self) -> Result<String, VisionKitError>

Returns the VisionKit selected text value.

pub fn selected_attributed_text( &self, ) -> Result<LiveTextAttributedText, VisionKitError>

Returns the VisionKit selected attributed text value.

pub fn selected_ranges(&self) -> Result<Vec<LiveTextTextRange>, VisionKitError>

Returns the VisionKit selected ranges value.

pub fn set_selected_ranges( &self, ranges: &[LiveTextTextRange], ) -> Result<(), VisionKitError>

Sets the VisionKit selected ranges value.

pub fn contents_rect(&self) -> Result<Rect, VisionKitError>

Returns the VisionKit contents rect value.

pub fn set_contents_rect_needs_update(&self) -> Result<(), VisionKitError>

Marks the VisionKit contents rectangle as needing an update.

pub fn has_interactive_item_at_point( &self, x: f64, y: f64, ) -> Result<bool, VisionKitError>

Returns whether VisionKit reports interactive item at point.

pub fn has_text_at_point(&self, x: f64, y: f64) -> Result<bool, VisionKitError>

Returns whether VisionKit reports text at point.

pub fn has_data_detector_at_point( &self, x: f64, y: f64, ) -> Result<bool, VisionKitError>

Returns whether VisionKit reports data detector at point.

pub fn has_supplementary_interface_at_point( &self, x: f64, y: f64, ) -> Result<bool, VisionKitError>

Returns whether VisionKit reports supplementary interface at point.

pub fn analysis_has_text_at_point( &self, x: f64, y: f64, ) -> Result<bool, VisionKitError>

Returns the VisionKit analysis has text at point value.

pub fn live_text_button_visible(&self) -> Result<bool, VisionKitError>

Returns the VisionKit live text button visible value.

pub fn is_supplementary_interface_hidden(&self) -> Result<bool, VisionKitError>

Returns whether VisionKit reports supplementary interface hidden.

pub fn set_supplementary_interface_hidden( &self, hidden: bool, animated: bool, ) -> Result<(), VisionKitError>

Sets the VisionKit supplementary interface hidden value.

pub fn supplementary_interface_content_insets( &self, ) -> Result<EdgeInsets, VisionKitError>

Returns the VisionKit supplementary interface content insets value.

pub fn set_supplementary_interface_content_insets( &self, insets: EdgeInsets, ) -> Result<(), VisionKitError>

Sets the VisionKit supplementary interface content insets value.

pub fn supplementary_interface_font( &self, ) -> Result<Option<LiveTextFont>, VisionKitError>

Returns the VisionKit supplementary interface font value.

pub fn set_supplementary_interface_font( &self, font: Option<&LiveTextFont>, ) -> Result<(), VisionKitError>

Sets the VisionKit supplementary interface font value.

pub fn begin_subject_analysis_if_necessary(&self) -> Result<(), VisionKitError>

Begins VisionKit subject analysis when the overlay requires it.

pub fn subjects(&self) -> Result<Vec<LiveTextSubject>, VisionKitError>

Returns the VisionKit subjects value.

pub fn highlighted_subjects( &self, ) -> Result<Vec<LiveTextSubject>, VisionKitError>

Returns the VisionKit highlighted subjects value.

pub fn set_highlighted_subjects( &self, subjects: &[LiveTextSubject], ) -> Result<(), VisionKitError>

Sets the VisionKit highlighted subjects value.

pub fn subject_at_point( &self, x: f64, y: f64, ) -> Result<Option<LiveTextSubject>, VisionKitError>

Returns the VisionKit subject at point value.

pub fn image_for_subjects( &self, subjects: &[LiveTextSubject], ) -> Result<LiveTextImageData, VisionKitError>

Returns the VisionKit image extracted for the provided subjects.

Trait Implementations

impl Drop for LiveTextInteraction

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.