Interface IProvidesSessionControl

Defines the API for controlling the MR session (not the MARS Session) This functionality provider is responsible for starting, stopping, creating, and destroying the MR session, which on most platforms controls other MR subsystems like camera tracking, plane finding, etc.

Namespace: Unity.MARS.Providers

Syntax

public interface IProvidesSessionControl : IFunctionalityProvider

Methods

CreateSession()

Create a new MR Session. If the session has been created, this does nothing.

Declaration

void CreateSession()

DestroySession()

Destroy the MR Session. If a session has not has been created, this does nothing.

Declaration

void DestroySession()

PauseSession()

Pauses the MR Session. If a session has been paused, this does nothing.

Declaration

void PauseSession()

ResetSession()

Resets the MR Session. This will trigger removal events for all current data

Declaration

void ResetSession()

ResumeSession()

Resumes the MR Session. If a session has not has been paused, this does nothing.

Declaration

void ResumeSession()

SessionExists()

Check if the session exists, regardless of whether it is running

Declaration

bool SessionExists()

Returns

Type	Description
Boolean	True if the session exists, false otherwise

SessionReady()

Check if the session is ready

Declaration

bool SessionReady()

Returns

Type	Description
Boolean	True if the session is ready, false otherwise

SessionRunning()

Check if the session is running. If the session does not exist, returns false

Declaration

bool SessionRunning()

Returns

Type	Description
Boolean	True if the session exists and is running, false otherwise