Skip to main content

PROTOCOL

ArdkFeatureSession

public protocol ArdkFeatureSession

A protocol that defines the common lifecycle and configuration interface for ARDK feature sessions.

Methods​

featureStatus()​

func featureStatus() -> ArdkFeatureStatus

Gets the current status of the feature.

This method reports any errors or warnings that have occurred within the feature system. Check this periodically to monitor the health of operations. Once an error is flagged, it will remain flagged until the problematic process runs again and completes successfully.

  • Returns: Feature status flags indicating current state and any issues

configure(with:)​

func configure(with config: Configuration) throws

start()​

func start()

Starts the feature session.

After starting, the session will begin processing incoming frame data according to its configured behavior. The session must be configured before starting.

stop()​

func stop()

Stops the feature session.

This halts all processing. The session can be reconfigured and restarted after stopping.