ARPlayableTexture Class Reference

#import <ARPlayableTexture.h>

Inheritance diagram for ARPlayableTexture:

Collaboration diagram for ARPlayableTexture:

Instance Methods
(void)	- reset
(void)	- play
(void)	- pause
(typedef)	- NS_ENUM
Instance Methods inherited from ARTexture
(instancetype)	- initWithUIImage:
(instancetype)	- initWithEmpty
(instancetype)	- initWithExistingTextureID:
(void)	- generateTexture
(void)	- uploadTexture
(void)	- loadTextureFromUIImage:reverseLines:
(void)	- uploadBGRATexture:width:height:
(void)	- uploadBGRATextureSub:width:height:
(BOOL)	- preRender
(void)	- postRender

Properties
float	frameRate
ARPlayableTextureState	playState
NSTimeInterval	pauseTolerance
NSTimeInterval	resetThreshold
BOOL	lastFramePersist
id< ARPlayableTextureDelegate >	delegate
Properties inherited from ARTexture
unsigned	textureID
unsigned long	width
unsigned long	height
BOOL	isPowerOfTwo
ARTextureFilter	minificationFilter
ARTextureFilter	magnificationFilter

Additional Inherited Members
Protected Attributes inherited from ARTexture
NSData *	_rawImage

Detailed Description

This class represents textures that are capable of changing, such as videos or 2D animations. This class should not be used directly. For Animations, please use ARAnimatedTexture. For Videos and Alpha Videos, please use ARVideoTexture.

Method Documentation

- (typedef) NS_ENUM		(NSInteger)
		(ARPlayableTextureState)

An enum representing the current state of a playable texture

< Playable texture is not initialised

< Playable texture is paused

< Playable texture is playing

< Playable texture has finished playing

- (void) pause

Pause playback of the playable texture.

- (void) play

Start playback of the playable texture.

- (void) reset

Resets the playable texture back to the beginning of its sequence.

Property Documentation

- (id<ARPlayableTextureDelegate>) delegate

readwritenonatomicweak

Delegate to receive playable texture events. Currently, the only delegate is playableTextureDidFinish.

- (float) frameRate

readwritenonatomicassign

The frame rate of the playable texture. This is set automatically but can be set manually in order to change playback speed.

- (BOOL) lastFramePersist

readwritenonatomicassign

Whether or not to continually render the last frame after the playable texture has finished playing. Default is NO.

- (NSTimeInterval) pauseTolerance

readwritenonatomicassign

The amount of time, in seconds, where the texture will continue to play even if it is not visible and no frames are being rendered. This is useful for momentary losses of tracking. The recommended value is 0.5 seconds.

- (NSTimeInterval) resetThreshold

readwritenonatomicassign

The amount of time, in seconds, to wait before resetting to the beginning, if the node is not being rendered. A value of 0 means the video will not reset.

---

The documentation for this class was generated from the following file:

• ARPlayableTexture.h