Struct AVPlayerView

Source

pub struct AVPlayerView { /* private fields */ }

Available on crate feature AVPlayerView and crate feature objc2-app-kit and macOS only.

Expand description

pub unsafe fn videoGravity(&self) -> Retained<AVLayerVideoGravity>

Available on crate feature objc2-av-foundation only.

A string defining how the video is displayed within an AVPlayerLayer bounds rect.

Options are AVLayerVideoGravityResizeAspect, AVLayerVideoGravityResizeAspectFill and AVLayerVideoGravityResize. AVLayerVideoGravityResizeAspect is default.

Source

pub unsafe fn setVideoGravity(&self, video_gravity: &AVLayerVideoGravity)

Available on crate feature objc2-av-foundation only.

Setter for videoGravity.

pub unsafe fn speeds(&self) -> Retained<NSArray<AVPlaybackSpeed>>

Available on crate feature AVPlaybackSpeed only.

A list of user selectable playback speeds to be shown in the playback speed control.

By default this property will be set to the systemDefaultSpeeds class property. Setting this property to nil will hide the playback speed selection UI.

To set the currently selected playback speed programmatically, either set the defaultRate on the AVPlayer associated with this view controller or use the selectSpeed method on AVPlayerView.

Source

pub unsafe fn setSpeeds(&self, speeds: &NSArray<AVPlaybackSpeed>)

Available on crate feature AVPlaybackSpeed only.

Setter for speeds.

This is copied when set.

Source

pub unsafe fn selectedSpeed(&self) -> Option<Retained<AVPlaybackSpeed>>

Available on crate feature AVPlaybackSpeed only.

The currently selected playback speed.

Changes to the associated AVPlayer’s defaultRate will be reflected in this property and vice versa. If the associated AVPlayer’s defaultRate is set to a value that does not match a speed in the speeds list property, the selected speed will be nil.

Source

pub unsafe fn selectSpeed(&self, speed: &AVPlaybackSpeed)

Available on crate feature AVPlaybackSpeed only.

Parameter speed: The playback speed to select.

Sets the input AVPlaybackSpeed as the selected speed.

Calls to selectSpeed with AVPlaybackSpeeds not contained within the speeds property array will be ignored.

Source

pub unsafe fn allowsVideoFrameAnalysis(&self) -> bool

When set to YES, the AVPlayerView will try to find objects, text and people while the media is paused. When an object is found, the user will be able to interact with it selecting and right clicking to present a context menu. Default is YES.

Source

Setter for allowsMagnification.

Source

pub unsafe fn magnification(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The factor by which the video’s view is currently scaled.

The default value is 1.0. The value cannot be smaller than 1.0 or larger 64.0. Nearest neighbor interpolation will be used once the content has been zoomed past a certain factor.

Source

pub unsafe fn setMagnification(&self, magnification: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for magnification.

Source

pub unsafe fn setMagnification_centeredAtPoint( &self, magnification: CGFloat, point: CGPoint, )

Available on crate feature objc2-core-foundation only.

Scales the video’s view by a specified factor and centers the result on a specified point.

Parameter magnification: The factor by which to scale the video’s view.

Parameter point: The point (in view space) on which to center magnification.

The magnification cannot be smaller than 1.0 or larger 64.0. Nearest neighbor interpolation will be used once the content has been zoomed past a certain factor.

Source

pub unsafe fn preferredDisplayDynamicRange(&self) -> AVDisplayDynamicRange

Available on crate feature AVKitTypes only.

Describes how High Dynamic Range (HDR) video content renders.

Defaults to AVDisplayDynamicRangeAutomatic.

Note: This property will only have effect if the video content supports HDR.

Source

pub unsafe fn setPreferredDisplayDynamicRange( &self, preferred_display_dynamic_range: AVDisplayDynamicRange, )

Available on crate feature AVKitTypes only.

Setter for preferredDisplayDynamicRange.

Source §

impl AVPlayerView

Methods declared on superclass NSView.

Source

pub unsafe fn initWithFrame( this: Allocated<Self>, frame_rect: NSRect, ) -> Retained<Self>

Source

pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

§Safety

coder possibly has further requirements.

Available on crate feature block2 only.

Parameter handler: A completion handler that is executed when the user selects either the Trim or Cancel button in the trimming UI.

Sets the controls panel into trimming mode and blocks until the user selects either the Trim or the Cancel button.

Source §

impl AVPlayerView

AVPlayerViewChapterIndicator.

Source

pub unsafe fn flashChapterNumber_chapterTitle( &self, chapter_number: NSUInteger, chapter_title: Option<&NSString>, )

Parameter chapterNumber: The chapter number (required).

Parameter chapterTitle: The chapter title (optional).

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub fn isHidden(&self) -> bool

Source

pub fn setHidden(&self, hidden: bool)

Setter for isHidden.

Source

pub fn isHiddenOrHasHiddenAncestor(&self) -> bool

Source

pub unsafe fn getRectsBeingDrawn_count( &self, rects: mut const CGRect, count: *mut isize, )

§Safety

rects must be a valid pointer or null.
count must be a valid pointer or null.

Source

pub unsafe fn sortSubviewsUsingFunction_context( &self, compare: unsafe extern "C-unwind" fn(NonNull<NSView>, NonNull<NSView>, mut c_void) -> NSComparisonResult, context: mut c_void, )

§Safety

compare must be implemented correctly.
context must be a valid pointer or null.

pub fn resizeSubviewsWithOldSize(&self, old_size: CGSize)

Source

Source

pub fn frame(&self) -> CGRect

Source

pub fn setFrame(&self, frame: CGRect)

Setter for frame.

Setter for bounds.

Setter for canDrawConcurrently.

Source

pub fn canDraw(&self) -> bool

👎Deprecated: If a view needs display, -drawRect: or -updateLayer will be called automatically when the view is able to draw. To check whether a view is in a window, call -window. To check whether a view is hidden, call -isHiddenOrHasHiddenAncestor.

Source

pub fn setNeedsDisplayInRect(&self, invalid_rect: CGRect)

Source

pub fn needsDisplay(&self) -> bool

Source

pub fn setAcceptsTouchEvents(&self, accepts_touch_events: bool)

👎Deprecated: Use allowedTouchTypes instead

Source

pub fn canDrawSubviewsIntoLayer(&self) -> bool

Source

pub fn setCanDrawSubviewsIntoLayer(&self, can_draw_subviews_into_layer: bool)

Setter for canDrawSubviewsIntoLayer.

Source

pub fn layoutSubtreeIfNeeded(&self)

Source

Setter for toolTip.

This is copied when set.

Source

pub unsafe fn addToolTipRect_owner_userData( &self, rect: CGRect, owner: &AnyObject, data: *mut c_void, ) -> isize

§Safety

owner should be of the correct type.
data must be a valid pointer or null.

Setter for preparedContentRect.

Source

pub fn allowsVibrancy(&self) -> bool

Source

pub fn viewDidChangeEffectiveAppearance(&self)

Override point for reacting to the effective appearance of the receiver changing. At this point effectiveAppearance property reflects the new appearance.

Source

pub unsafe fn nextKeyView(&self) -> Option<Retained<NSView>>

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub unsafe fn setNextKeyView(&self, next_key_view: Option<&NSView>)

Setter for nextKeyView.

Source

pub unsafe fn print(&self, sender: Option<&AnyObject>)

§Safety

sender should be of the correct type.

Source

pub unsafe fn knowsPageRange(&self, range: *mut NSRange) -> bool

§Safety

range must be a valid pointer.

§Safety

options generic should be of the correct type.

Setter for additionalSafeAreaInsets.

Source

pub fn safeAreaRect(&self) -> CGRect

Source

pub fn prefersCompactControlSizeMetrics(&self) -> bool

When this property is true, any NSControls in the view or its descendants will be sized with compact metrics compatible with macOS 15 and earlier. Defaults to false

Source

pub fn setPrefersCompactControlSizeMetrics( &self, prefers_compact_control_size_metrics: bool, )

Setter for prefersCompactControlSizeMetrics.

Source

👎Deprecated

Methods from Deref<Target = NSResponder>§

Source

pub unsafe fn nextResponder(&self) -> Option<Retained<NSResponder>>

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub unsafe fn setNextResponder(&self, next_responder: Option<&NSResponder>)

Setter for nextResponder.

Source

pub fn becomeFirstResponder(&self) -> bool

Source

pub fn resignFirstResponder(&self) -> bool

Source

pub fn flushBufferedKeyEvents(&self)

Source

Source

pub fn presentError(&self, error: &NSError) -> bool

Source

pub fn willPresentError(&self, error: &NSError) -> Retained<NSError>

Source

pub fn performMnemonic(&self, string: &NSString) -> bool

👎Deprecated: This has always returned NO and had no effect on macOS

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

The name of the Objective-C class that this type represents. Read more

Source §

type Super = NSView

The superclass of this class. Read more

Source §

type ThreadKind = <<AVPlayerView as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread. Read more

Source §

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more

Dereferences the value.

Source §

impl Hash for AVPlayerView

Source §

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Source §

impl Message for AVPlayerView

Source §

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more

Source §

Safety Read more

fn animationForKey(&self, key: &NSString) -> Option<Retained<AnyObject>>
where Self: Sized + Message,

Source §

fn defaultAnimationForKey(key: &NSString) -> Option<Retained<AnyObject>>
where Self: Sized + ClassType,

Source §

impl NSAppearanceCustomization for AVPlayerView

Source §

Check whether the object is equal to an arbitrary other object. Read more

Source §

fn hash(&self) -> usize
where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure. Read more

Source §

fn isKindOfClass(&self, cls: &AnyClass) -> bool
where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses. Read more

Source §

fn is_kind_of<T>(&self) -> bool
where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Source §

fn identifier(&self) -> Option<Retained<NSString>>
where Self: Sized + Message,

Source §

fn setIdentifier(&self, identifier: Option<&NSString>)
where Self: Sized + Message,

Setter for identifier. Read more

Source §

impl PartialEq for AVPlayerView

Source §

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn alloc(mtm: MainThreadMarker) -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class on the main thread. Read more

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

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

Struct AVPlayerView Copy item path

Implementations§

impl AVPlayerView

pub unsafe fn player(&self) -> Option<Retained<AVPlayer>>

pub unsafe fn setPlayer(&self, player: Option<&AVPlayer>)

pub unsafe fn controlsStyle(&self) -> AVPlayerViewControlsStyle

pub unsafe fn setControlsStyle(&self, controls_style: AVPlayerViewControlsStyle)

pub unsafe fn videoGravity(&self) -> Retained<AVLayerVideoGravity>

pub unsafe fn setVideoGravity(&self, video_gravity: &AVLayerVideoGravity)

pub unsafe fn isReadyForDisplay(&self) -> bool

pub unsafe fn videoBounds(&self) -> NSRect

pub unsafe fn contentOverlayView(&self) -> Option<Retained<NSView>>

pub unsafe fn updatesNowPlayingInfoCenter(&self) -> bool

pub unsafe fn setUpdatesNowPlayingInfoCenter( &self, updates_now_playing_info_center: bool, )

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn AVPlayerViewDelegate>>>

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn AVPlayerViewDelegate>>, )

pub unsafe fn speeds(&self) -> Retained<NSArray<AVPlaybackSpeed>>

pub unsafe fn setSpeeds(&self, speeds: &NSArray<AVPlaybackSpeed>)

pub unsafe fn selectedSpeed(&self) -> Option<Retained<AVPlaybackSpeed>>

pub unsafe fn selectSpeed(&self, speed: &AVPlaybackSpeed)

pub unsafe fn allowsVideoFrameAnalysis(&self) -> bool

pub unsafe fn setAllowsVideoFrameAnalysis( &self, allows_video_frame_analysis: bool, )

pub unsafe fn videoFrameAnalysisTypes(&self) -> AVVideoFrameAnalysisType

pub unsafe fn setVideoFrameAnalysisTypes( &self, video_frame_analysis_types: AVVideoFrameAnalysisType, )

pub unsafe fn allowsMagnification(&self) -> bool

pub unsafe fn setAllowsMagnification(&self, allows_magnification: bool)

pub unsafe fn magnification(&self) -> CGFloat

pub unsafe fn setMagnification(&self, magnification: CGFloat)

pub unsafe fn setMagnification_centeredAtPoint( &self, magnification: CGFloat, point: CGPoint, )

pub unsafe fn preferredDisplayDynamicRange(&self) -> AVDisplayDynamicRange

pub unsafe fn setPreferredDisplayDynamicRange( &self, preferred_display_dynamic_range: AVDisplayDynamicRange, )

impl AVPlayerView

pub unsafe fn initWithFrame( this: Allocated<Self>, frame_rect: NSRect, ) -> Retained<Self>

pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

§Safety

impl AVPlayerView

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

impl AVPlayerView

pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>

impl AVPlayerView

pub unsafe fn showsFrameSteppingButtons(&self) -> bool

pub unsafe fn setShowsFrameSteppingButtons( &self, shows_frame_stepping_buttons: bool, )

pub unsafe fn showsSharingServiceButton(&self) -> bool

pub unsafe fn setShowsSharingServiceButton( &self, shows_sharing_service_button: bool, )

pub unsafe fn actionPopUpButtonMenu(&self) -> Option<Retained<NSMenu>>

pub unsafe fn setActionPopUpButtonMenu( &self, action_pop_up_button_menu: Option<&NSMenu>, )

pub unsafe fn showsFullScreenToggleButton(&self) -> bool

pub unsafe fn setShowsFullScreenToggleButton( &self, shows_full_screen_toggle_button: bool, )

pub unsafe fn showsTimecodes(&self) -> bool

pub unsafe fn setShowsTimecodes(&self, shows_timecodes: bool)

impl AVPlayerView

pub unsafe fn canBeginTrimming(&self) -> bool

pub unsafe fn beginTrimmingWithCompletionHandler( &self, handler: Option<&DynBlock<dyn Fn(AVPlayerViewTrimResult)>>, )

impl AVPlayerView

pub unsafe fn flashChapterNumber_chapterTitle( &self, chapter_number: NSUInteger, chapter_title: Option<&NSString>, )

impl AVPlayerView

pub unsafe fn allowsPictureInPicturePlayback(&self) -> bool

pub unsafe fn setAllowsPictureInPicturePlayback( &self, allows_picture_in_picture_playback: bool, )

pub unsafe fn pictureInPictureDelegate( &self, ) -> Option<Retained<ProtocolObject<dyn AVPlayerViewPictureInPictureDelegate>>>

pub unsafe fn setPictureInPictureDelegate( &self, picture_in_picture_delegate: Option<&ProtocolObject<dyn AVPlayerViewPictureInPictureDelegate>>, )

Methods from Deref<Target = NSView>§

pub unsafe fn superview(&self) -> Option<Retained<NSView>>

§Safety

pub fn subviews(&self) -> Retained<NSArray<NSView>>

pub fn setSubviews(&self, subviews: &NSArray<NSView>)

pub fn isDescendantOf(&self, view: &NSView) -> bool

pub fn ancestorSharedWithView(&self, view: &NSView) -> Option<Retained<NSView>>

pub unsafe fn opaqueAncestor(&self) -> Option<Retained<NSView>>

§Safety

pub fn isHidden(&self) -> bool

pub fn setHidden(&self, hidden: bool)

pub fn isHiddenOrHasHiddenAncestor(&self) -> bool

pub unsafe fn getRectsBeingDrawn_count( &self, rects: *mut *const CGRect, count: *mut isize, )

§Safety

pub fn needsToDrawRect(&self, rect: CGRect) -> bool

pub fn wantsDefaultClipping(&self) -> bool

pub fn viewDidHide(&self)

pub fn viewDidUnhide(&self)

pub fn addSubview(&self, view: &NSView)

pub unsafe fn sortSubviewsUsingFunction_context( &self, compare: unsafe extern "C-unwind" fn(NonNull<NSView>, NonNull<NSView>, *mut c_void) -> NSComparisonResult, context: *mut c_void, )

Struct AVPlayerView

pub unsafe fn getRectsBeingDrawn_count( &self, rects: mut const CGRect, count: *mut isize, )

pub unsafe fn sortSubviewsUsingFunction_context( &self, compare: unsafe extern "C-unwind" fn(NonNull<NSView>, NonNull<NSView>, mut c_void) -> NSComparisonResult, context: mut c_void, )