public final class Session

A session is the main entrypoint to features provided by ARCore for Jetpack XR. It manages the system's state and its lifecycle, and contains the state of objects tracked by ARCore for Jetpack XR.

This class owns a significant amount of native heap memory. The Session's lifecycle will be scoped to the Activity that owns it.

Summary

Public methods
final @NonNull SessionConfigureResult

Sets or changes the configuration to use.
static final @NonNull SessionCreateResult
create(
    @NonNull Activity activity,
    @NonNull CoroutineContext coroutineContext
)

Creates a new Session.
static final @NonNull SessionCreateResult
create(
    @NonNull Activity activity,
    @NonNull LifecycleOwner lifecycleOwner,
    @NonNull CoroutineContext coroutineContext
)

Creates a new Session with a provided LifecycleOwner.
final @NonNull Config

The current state of the runtime configuration.
final @NonNull StateFlow<@NonNull CoreState>

A StateFlow of the current state.

Extension functions
final @NonNull Flowable<@NonNull CoreState>

A Flowable of the current CoreState.
final @NonNull Scene

Gets the Scene associated with this Session.

Public methods

configure

Added in 1.0.0-alpha05
public final @NonNull SessionConfigureResult configure(@NonNull Config config)

Sets or changes the configuration to use.

Returns
@NonNull SessionConfigureResult

the result of the operation. This will be a SessionConfigureSuccess if the configuration was successful, or another SessionConfigureResult if a certain configuration criteria was not met.
Throws
kotlin.IllegalStateException

if the session has been destroyed.
java.lang.SecurityException

if the necessary permissions have not been granted to the calling application for the provided configuration.

create

Added in 1.0.0-alpha05
public static final @NonNull SessionCreateResult create(
    @NonNull Activity activity,
    @NonNull CoroutineContext coroutineContext
)

Creates a new Session.

Parameters
@NonNull Activity activity

the Activity that provides the context for the session's resources and controls the session's runtime state based on the activity's lifecycle.
@NonNull CoroutineContext coroutineContext

the CoroutineContext that will be used to handle the session's coroutines.
Returns
@NonNull SessionCreateResult

the result of the operation. Can be SessionCreateSuccess, which contains the newly created session, or another SessionCreateResult if a certain criteria was not met.
Throws
java.lang.SecurityException

if the Session is backed by Google Play Services for AR and android.Manifest.permission.CAMERA has not been granted to the calling application.

create

Added in 1.0.0-alpha05
public static final @NonNull SessionCreateResult create(
    @NonNull Activity activity,
    @NonNull LifecycleOwner lifecycleOwner,
    @NonNull CoroutineContext coroutineContext
)

Creates a new Session with a provided LifecycleOwner.

Only use this version of the constructor if you desire to have finer control over the session's lifecycle. The lifecycleOwner's lifecycle must still be bounded within the lifecycle of the provided activity. The session will be automatically destroyed if the activity's lifecycle becomes destroyed.

Parameters
@NonNull Activity activity

the Activity that provides the context for the session's resources.
@NonNull LifecycleOwner lifecycleOwner

the LifecycleOwner whose lifecycle controls the runtime state of the session.
@NonNull CoroutineContext coroutineContext

the CoroutineContext that will be used to handle the session's coroutines.
Returns
@NonNull SessionCreateResult

the result of the operation. Can be SessionCreateSuccess, which contains the newly created session, or another SessionCreateResult if a certain criteria was not met.
Throws
java.lang.SecurityException

if the Session is backed by Google Play Services for AR and android.Manifest.permission.CAMERA has not been granted to the calling application.

getConfig

Added in 1.0.0-alpha05
public final @NonNull Config getConfig()

The current state of the runtime configuration.

getState

Added in 1.0.0-alpha05
public final @NonNull StateFlow<@NonNull CoreState> getState()

A StateFlow of the current state.

Extension functions

RxJava3SessionKt.getStateAsFlowable

public final @NonNull Flowable<@NonNull CoreState> RxJava3SessionKt.getStateAsFlowable(@NonNull Session receiver)

A Flowable of the current CoreState.

SessionExtKt.getScene

public final @NonNull Scene SessionExtKt.getScene(@NonNull Session receiver)

Gets the Scene associated with this Session.

The Scene is the primary interface for creating and managing spatial content. There is a single Scene instance for each Session.

See also
Scene