Table Of Contents

Previous topic

Engine Class

Next topic

FrameFilter Class

Frame Class

Inherits: Drawable

Description

Frame is the class to store tracked data.

The data includes current camera image(s), tracked targets and other related information.

Constructor

C: void easyar_Frame__ctor(easyar_Frame** Return)
C++11: Frame()
Traditional C++: Frame()
Java: public Frame()
Objective-C: + (easyar_Frame *) create
Swift (since EasyAR SDK 2.1.0): public convenience init()

size

Image size for display.

C: easyar_Vec2I easyar_Frame_size(const easyar_Frame* This)
C++11: Vec2I size()
Traditional C++: Vec2I size()
Java: public native Vec2I size()
Objective-C: - (easyar_Vec2I *)size
Swift (since EasyAR SDK 2.1.0): public func size() -> Vec2I

timestamp

Returns time stamp of the frame.

C: double easyar_Frame_timestamp(const easyar_Frame* This)
C++11: double timestamp()
Traditional C++: double timestamp()
Java: public native double timestamp()
Objective-C: - (double)timestamp
Swift (since EasyAR SDK 2.1.0): public func timestamp() -> Double

index

Returns frame index.

C: int easyar_Frame_index(const easyar_Frame* This)
C++11: int index()
Traditional C++: int index()
Java: public native int index()
Objective-C: - (int)index
Swift (since EasyAR SDK 2.1.0): public func index() -> Int32

images

Returns a list of images inside the frame.

C: void easyar_Frame_images(const easyar_Frame* This, easyar_ListOfPointerOfImage** Return)
C++11: std::vector<std::shared_ptr<Image>> images()
Traditional C++: void images(ListOfPointerOfImage** Return)
Java: public native java.util.ArrayList<Image> images()
Objective-C: - (NSArray<easyar_Image *> *)images
Swift (since EasyAR SDK 2.1.0): public func images() -> [Image]

targetInstances

Returns a list of TargetInstance inside the frame.

C: void easyar_Frame_targetInstances(const easyar_Frame* This, easyar_ListOfPointerOfTargetInstance** Return)
C++11: std::vector<std::shared_ptr<TargetInstance>> targetInstances()
Traditional C++: void targetInstances(ListOfPointerOfTargetInstance** Return)
Java: public native java.util.ArrayList<TargetInstance> targetInstances()
Objective-C: - (NSArray<easyar_TargetInstance *> *)targetInstances
Swift (since EasyAR SDK 2.1.0): public func targetInstances() -> [TargetInstance]

text

Returns text message inside the frame. Returns an empty string if no text inside.

C: void easyar_Frame_text(easyar_Frame* This, easyar_String** Return)
C++11: std::string text()
Traditional C++: void text(String** Return)
Java: public native java.lang.String text()
Objective-C: - (NSString *)text
Swift (since EasyAR SDK 2.1.0): public func text() -> String