ARVideoNode Class Reference

#import <ARVideoNode.h>

Inheritance diagram for ARVideoNode:

Collaboration diagram for ARVideoNode:

Instance Methods
(instancetype)	- initWithVideoTexture:
(instancetype)	- initWithBundledFile:
(void)	- play
(void)	- pause
(void)	- reset
Instance Methods inherited from ARNode
(void)	- addChild:
(void)	- addChildren:
(void)	- removeChild:
(void)	- removeAllChildren
(void)	- remove
(ARNode *)	- findChildWithName:
(void)	- markWorldTransformAsDirty
(void)	- translateByX:y:z:
(void)	- translateByX:y:z:transformSpace:
(void)	- translateByVector:
(void)	- translateByVector:transformSpace:
(void)	- scaleByUniform:
(void)	- scaleByX:y:z:
(void)	- scaleByVector:
(void)	- rotateByDegrees:axisX:y:z:
(void)	- rotateByRadians:axisX:y:z:
(void)	- rotateByQuaternion:
(ARVector3 *)	- positionToWorld:
(ARVector3 *)	- positionToEye:
(ARQuaternion *)	- orientationToWorld:
(ARQuaternion *)	- orientationToEye:
(CGPoint)	- viewPortFromNodePosition:
(void)	- render
(void)	- preRender
(void)	- postRender
(void)	- addTouchTarget:withAction:
(void)	- didReceiveTouch
(ARVector3 *)	- nodeFromViewPort:

Properties
ARVideoTexture *	videoTexture
ARVideoTextureMaterial *	videoTextureMaterial
Properties inherited from ARMeshNode
ARMesh *	mesh
ARMaterial *	material
BOOL	cull
Properties inherited from ARNode
NSString *	name
ARNode *	parent
NSArray< ARNode * > *	children
NSArray *	descendants
ARVector3 *	position
ARVector3 *	scale
ARQuaternion *	orientation
ARMatrix4 *	localTransform
ARMatrix4 *	worldTransform
ARMatrix4 *	fullTransform
ARQuaternion *	fullOrientation
ARQuaternion *	worldOrientation
ARVector3 *	worldScale
ARVector3 *	worldPosition
ARVector3 *	fullPosition
ARNode *	world
NSUInteger	childCount
BOOL	visible

Additional Inherited Members
Class Methods inherited from ARMeshNode
(instancetype)	+ testMeshNodeWithRed:green:blue:
(instancetype)	+ testMeshNodeWithTexture:
(instancetype)	+ meshNodeWithTexture:width:height:
(instancetype)	+ meshNodeWithRed:green:blue:width:height:
Class Methods inherited from ARNode
(instancetype)	+ nodeWithName:
Protected Member Functions inherited from ARNode
(typedef)	- NS_ENUM

Detailed Description

An ARVideoNode is a subclass of ARNode that is used to render video content.

Method Documentation

- (instancetype) initWithBundledFile:

(NSString *)

file

Initialise with a file in the app bundle. This is the simplest and easiest way to load a video file that has audio into a video node.

Example of use:

ARVideoNode *videoNode = [[ARVideoNode alloc] initWithBundledFile:@"Assets/example.mp4"];

Parameters

file	The file in the app bundle to initialise with. The file path is relative to the app bundle and includes the file extension. For example, if your video is called "example.mp4" and is located in a group within your project called "Assets", the required path would be: "Assets/example.mp4".

- (instancetype) initWithVideoTexture:

(ARVideoTexture *)

videoTexture

Initialise an ARVideoNode using a video texture. This is useful for when your video and audio are in separate files.

Example of use:

ARVideoTexture *videoTexture = [[ARVideoTexture alloc] initWithVideoFile:@"example.mp4" audioFile:"example.mp4"];
ARVideoNode *videoNode = [[ARVideoNode alloc] initWithVideoTexture:videoTexture];

Parameters

videoTexture

The video texture to initialise with.

- (void) pause

Pauses playback. Current video time will be saved.

Example of use:

[videoNode pause];

- (void) play

Starts/resumes playback from the saved time. If no time is currently saved, starts from the beginning. Default playback state is paused.

Example of use:

[videoNode play];

- (void) reset

Reset the video's position to 0 and its state to paused.

Example of use:

[videoNode reset];

Property Documentation

- (ARVideoTexture*) videoTexture

readwritenonatomicassign

The video texture associated with the node.

- (ARVideoTextureMaterial*) videoTextureMaterial

readwritenonatomicassign

Convenient access to this node's material without need for a cast.

---

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

• ARVideoNode.h