ARPlayableTexture Class Reference

#import <ARPlayableTexture.h>

Inherits ARTexture.

Inherited by ARAnimatedTexture, and ARVideoTexture.

Instance Methods
(void)	- reset
(void)	- play
(void)	- pause
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

Protected Types
enum	ARPlayableTextureState { ARPlayableTextureStateUninitialised, ARPlayableTextureStatePaused, ARPlayableTextureStatePlaying, ARPlayableTextureStateFinished }
Protected Types inherited from ARTexture
enum	ARTextureFilter { ARTextureFilterNearest, ARTextureFilterLinear }

Properties
ARPlayableTextureState	playState
float	frameRate
NSTimeInterval	pauseTolerance
NSTimeInterval	resetThreshold
BOOL	lastFramePersist
id< ARPlayableTextureDelegate >	delegate
Properties inherited from ARTexture
GLuint	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.

Member Enumeration Documentation

ARPlayableTextureState

- (enum) ARPlayableTextureState

protected

An enum representing the current state of a playable texture

Enumerator
ARPlayableTextureStateUninitialised	Playable texture has not yet been initialised.
ARPlayableTextureStatePaused	Playable texture is currently paused and will continue to render the current frame.
ARPlayableTextureStatePlaying	Playable texture is currently playing.
ARPlayableTextureStateFinished	Playable texture has finished playback and will either reset or keep rendering the last frame.

Method Documentation

pause

- (void) pause

Pause playback of the playable texture.

play

- (void) play

Start playback of the playable texture.

reset

- (void) reset

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

Property Documentation

delegate

- (id<ARPlayableTextureDelegate>) delegate

readwritenonatomicweak

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

frameRate

- (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.

lastFramePersist

- (BOOL) lastFramePersist

readwritenonatomicassign

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

pauseTolerance

- (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.

playState

- (ARPlayableTextureState) playState

readwritenonatomicassign

The current state of this playable texture.

resetThreshold

- (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 files:

• ARPlayableTexture.h
• ARPlayableTexture.m