Table Of Contents

Previous topic

FrameFilter Class

Next topic

Image Class

FrameStreamer Class


FrameStreamer is the base class for frame data provider. It generates frame to feed filters, from camera or other devices or files.

If you are looking for a customizable frame feeder to use your own video source, it is not available yet in the latest EasyAR SDK, but will be available as subclass of FrameStreamer in some later releases.


Peek the latest frame from streamer.

C: void easyar_FrameStreamer_peek(easyar_FrameStreamer* This, easyar_Frame** Return)
C++11: std::shared_ptr<Frame> peek()
Traditional C++: void peek(Frame** Return)
Java: public native Frame peek()
Objective-C: - (easyar_Frame *)peek
Swift (since EasyAR SDK 2.1.0): public func peek() -> Frame


Start to streaming frames.

C: bool easyar_FrameStreamer_start(easyar_FrameStreamer* This)
C++11: bool start()
Traditional C++: bool start()
Java: public native boolean start()
Objective-C: - (bool)start
Swift (since EasyAR SDK 2.1.0): public func start() -> Bool


Stop streaming.

C: bool easyar_FrameStreamer_stop(easyar_FrameStreamer* This)
C++11: bool stop()
Traditional C++: bool stop()
Java: public native boolean stop()
Objective-C: - (bool)stop
Swift (since EasyAR SDK 2.1.0): public func stop() -> Bool