apple.avkit

Class AVPictureInPictureController

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.avkit.AVPictureInPictureController

All Implemented Interfaces:

NSObject

public class AVPictureInPictureController
extends NSObject

AVPictureInPictureController

AVPictureInPictureController is a subclass of NSObject that can be used to present the contents of an AVPlayerLayer or AVPlayerView floating on top of applications.

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AVPictureInPictureController(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
static boolean	accessInstanceVariablesDirectly()
static AVPictureInPictureController	alloc()
static AVPictureInPictureController	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
static void	cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)
boolean	canStartPictureInPictureAutomaticallyFromInline() [@property] canStartPictureInPictureAutomaticallyFromInline
static NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static org.moe.natj.objc.Class	classForKeyedUnarchiver()
AVPictureInPictureControllerContentSource	contentSource() [@property] contentSource
static java.lang.String	debugDescription_static()
AVPictureInPictureControllerDelegate	delegate() [@property] delegate
static java.lang.String	description_static()
static long	hash_static()
AVPictureInPictureController	init()
AVPictureInPictureController	initWithContentSource(AVPictureInPictureControllerContentSource contentSource) initWithContentSource:
AVPictureInPictureController	initWithPlayerLayer(AVPlayerLayer playerLayer) initWithPlayerLayer:
static NSObject.Function_instanceMethodForSelector_ret	instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
static NSMethodSignature	instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
static boolean	instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
void	invalidatePlaybackState() invalidatePlaybackState
boolean	isPictureInPictureActive() [@property] pictureInPictureActive
boolean	isPictureInPicturePossible() [@property] pictureInPicturePossible
static boolean	isPictureInPictureSupported() isPictureInPictureSupported
boolean	isPictureInPictureSuspended() [@property] pictureInPictureSuspended
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
static NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
static AVPictureInPictureController	new_objc()
static UIImage	pictureInPictureButtonStartImage() [@property] pictureInPictureButtonStartImage
static UIImage	pictureInPictureButtonStartImageCompatibleWithTraitCollection(UITraitCollection traitCollection) pictureInPictureButtonStartImageCompatibleWithTraitCollection:
static UIImage	pictureInPictureButtonStopImage() [@property] pictureInPictureButtonStopImage
static UIImage	pictureInPictureButtonStopImageCompatibleWithTraitCollection(UITraitCollection traitCollection) pictureInPictureButtonStopImageCompatibleWithTraitCollection:
AVPlayerLayer	playerLayer() [@property] playerLayer
boolean	requiresLinearPlayback() [@property] requiresLinearPlayback
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
void	setCanStartPictureInPictureAutomaticallyFromInline(boolean value) [@property] canStartPictureInPictureAutomaticallyFromInline
void	setContentSource(AVPictureInPictureControllerContentSource value) [@property] contentSource
void	setDelegate_unsafe(AVPictureInPictureControllerDelegate value) [@property] delegate
void	setDelegate(AVPictureInPictureControllerDelegate value) [@property] delegate
void	setRequiresLinearPlayback(boolean value) [@property] requiresLinearPlayback
static void	setVersion_static(long aVersion)
void	startPictureInPicture() startPictureInPicture
void	stopPictureInPicture() stopPictureInPicture
static org.moe.natj.objc.Class	superclass_static()
static long	version_static()

Methods inherited from class apple.NSObject

accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject

equals, toString

Methods inherited from class org.moe.natj.general.NativeObject

finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AVPictureInPictureController

protected AVPictureInPictureController(org.moe.natj.general.Pointer peer)

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static AVPictureInPictureController alloc()

allocWithZone

public static AVPictureInPictureController allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)

automaticallyNotifiesObserversForKey

public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)

cancelPreviousPerformRequestsWithTarget

public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)

cancelPreviousPerformRequestsWithTargetSelectorObject

public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

classFallbacksForKeyedArchiver

public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

classForKeyedUnarchiver

public static org.moe.natj.objc.Class classForKeyedUnarchiver()

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

hash_static

public static long hash_static()

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

instanceMethodSignatureForSelector

public static NSMethodSignature instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)

instancesRespondToSelector

public static boolean instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)

isPictureInPictureSupported

public static boolean isPictureInPictureSupported()

isPictureInPictureSupported

Whether or not Picture in Picture is supported on the current device.

When NO, all initializers will return nil.

isSubclassOfClass

public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)

keyPathsForValuesAffectingValueForKey

public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)

new_objc

public static AVPictureInPictureController new_objc()

pictureInPictureButtonStartImageCompatibleWithTraitCollection

public static UIImage pictureInPictureButtonStartImageCompatibleWithTraitCollection(UITraitCollection traitCollection)

pictureInPictureButtonStartImageCompatibleWithTraitCollection:

System default Picture in Picture start template image for use in client's Picture in Picture button.

Parameters:

traitCollection - Traits that describe the image to retrieve, pass nil to use traits that describe the main screen.

pictureInPictureButtonStopImageCompatibleWithTraitCollection

public static UIImage pictureInPictureButtonStopImageCompatibleWithTraitCollection(UITraitCollection traitCollection)

pictureInPictureButtonStopImageCompatibleWithTraitCollection:

System default Picture in Picture stop template image for use in client's Picture in Picture button.

Parameters:

traitCollection - Traits that describe the image to retrieve, pass nil to use traits that describe the main screen.

resolveClassMethod

public static boolean resolveClassMethod(org.moe.natj.objc.SEL sel)

resolveInstanceMethod

public static boolean resolveInstanceMethod(org.moe.natj.objc.SEL sel)

setVersion_static

public static void setVersion_static(long aVersion)

superclass_static

public static org.moe.natj.objc.Class superclass_static()

version_static

public static long version_static()

delegate

public AVPictureInPictureControllerDelegate delegate()

[@property] delegate

The receiver's delegate.

init

public AVPictureInPictureController init()

Overrides:

init in class NSObject

initWithPlayerLayer

public AVPictureInPictureController initWithPlayerLayer(AVPlayerLayer playerLayer)

initWithPlayerLayer:

Initialize the picture in picture controller with a player layer.

Parameters:

playerLayer - The player layer from which to source the media content for the Picture in Picture controller.

isPictureInPictureActive

public boolean isPictureInPictureActive()

[@property] pictureInPictureActive

Whether or not Picture in Picture is currently active.

isPictureInPicturePossible

public boolean isPictureInPicturePossible()

[@property] pictureInPicturePossible

Whether or not Picture in Picture is currently possible.

isPictureInPictureSuspended

public boolean isPictureInPictureSuspended()

[@property] pictureInPictureSuspended

Whether or not Picture in Picture is currently suspended.

playerLayer

public AVPlayerLayer playerLayer()

[@property] playerLayer

The receiver's player layer.

setDelegate_unsafe

public void setDelegate_unsafe(AVPictureInPictureControllerDelegate value)

[@property] delegate

The receiver's delegate.

setDelegate

public void setDelegate(AVPictureInPictureControllerDelegate value)

[@property] delegate

The receiver's delegate.

startPictureInPicture

public void startPictureInPicture()

startPictureInPicture

Start Picture in Picture for the provided AVPlayerLayer if possible.

Receiver will call -pictureInPictureControllerWillStartPictureInPicture: if Picture in Picture is currently possible and -pictureInPictureControllerDidStartPictureInPicture: after a successful start. If starting Picture in Picture fails, -pictureInPictureControllerFailedToStartPictureInPicture:withError: is called on the delegate instead. Client can stop Picture in Picture by calling -stopPictureInPicture. In addition the user can stop Picture in Picture through user interaction. It is also possible that Picture in Picture is stopped by the Picture in Picture controller at any time. In all these cases receiver calls -pictureInPictureControllerWillStopPictureInPicture: on the delegate and -pictureInPictureControllerDidStopPictureInPicture:after the stop animation completed.

stopPictureInPicture

public void stopPictureInPicture()

stopPictureInPicture

Stop the local Picture in Picture if currently active. On tvOS, this can also stop Picture in Picture sessions for other applications.

See startPictureInPicture for details.

pictureInPictureButtonStartImage

public static UIImage pictureInPictureButtonStartImage()

[@property] pictureInPictureButtonStartImage

System default Picture in Picture start template image for use in client's Picture in Picture button.

pictureInPictureButtonStopImage

public static UIImage pictureInPictureButtonStopImage()

[@property] pictureInPictureButtonStopImage

System default Picture in Picture stop template image for use in client's Picture in Picture button.

requiresLinearPlayback

public boolean requiresLinearPlayback()

[@property] requiresLinearPlayback

Disables certain user operations (fast forward, forward skip, and scrubbing).

This can be used to temporarily enforce playback of mandatory content (such as legalese or advertisements).

setRequiresLinearPlayback

public void setRequiresLinearPlayback(boolean value)

[@property] requiresLinearPlayback

Disables certain user operations (fast forward, forward skip, and scrubbing).

This can be used to temporarily enforce playback of mandatory content (such as legalese or advertisements).

canStartPictureInPictureAutomaticallyFromInline

public boolean canStartPictureInPictureAutomaticallyFromInline()

[@property] canStartPictureInPictureAutomaticallyFromInline

Indicates whether Picture in Picture should be allowed to start automatically when transitioning to background when the receiver’s content is embedded inline. Default is NO.

This property must only be set to YES for content intended to be the user's primary focus.

setCanStartPictureInPictureAutomaticallyFromInline

public void setCanStartPictureInPictureAutomaticallyFromInline(boolean value)

[@property] canStartPictureInPictureAutomaticallyFromInline

Indicates whether Picture in Picture should be allowed to start automatically when transitioning to background when the receiver’s content is embedded inline. Default is NO.

This property must only be set to YES for content intended to be the user's primary focus.

contentSource

public AVPictureInPictureControllerContentSource contentSource()

[@property] contentSource

The receiver's content source. Can be changed while Picture in Picture is active, but the new content source must be ready for display (in the case of AVPlayerLayer, that means AVPlayerLayer.isReadyForDisplay must return YES), otherwise Picture in Picture will stop.

initWithContentSource

public AVPictureInPictureController initWithContentSource(AVPictureInPictureControllerContentSource contentSource)

initWithContentSource:

Use this initializer for content that may be a sample buffer display layer or a player layer.

Parameters:

contentSource - The content source to be shown in Picture in Picture.

invalidatePlaybackState

public void invalidatePlaybackState()

invalidatePlaybackState

Informs Picture in Picture controller that it should request an updated playback state from its sampleBufferPlaybackDelegate.

This should always be called whenever playback is paused or unpaused, or the underlying content duration changes.

setContentSource

public void setContentSource(AVPictureInPictureControllerContentSource value)

[@property] contentSource

The receiver's content source. Can be changed while Picture in Picture is active, but the new content source must be ready for display (in the case of AVPlayerLayer, that means AVPlayerLayer.isReadyForDisplay must return YES), otherwise Picture in Picture will stop.