DeepARController class
Controller for the DeepAR augmented reality engine.
Provides camera capture, AR effect loading/unloading, camera switching, and a stream of AR-processed frames via frameStream.
Usage:
final deepar = DeepARController();
await deepar.initialize(licenseKey: 'YOUR_KEY');
await deepar.startCapture();
deepar.frameStream.listen((frame) {
// Use frame.data, frame.width, frame.height
});
await deepar.loadEffect('effects/my_filter.deepar');
Constructors
Properties
-
frameStream
→ Stream<
DeepARFrame> -
Stream of AR-processed frames.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isInitialized → bool
-
Whether the DeepAR SDK has been initialized.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
clearEffect(
) → Future< void> - Clear the current AR effect.
-
dispose(
) → Future< void> - Fully release all DeepAR resources.
-
initialize(
{required String licenseKey}) → Future< bool> - Initialize the DeepAR engine with your license key.
-
loadEffect(
String? effectPath) → Future< void> - Load an AR effect file.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
startCapture(
) → Future< void> - Start camera capture and begin receiving processed frames via frameStream.
-
stopCapture(
) → Future< void> - Stop camera capture and frame delivery.
-
switchCamera(
) → Future< void> - Switch between front and back camera.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited