interface IARConfiguration (Niantic.ARDK.AR.Configuration.IARConfiguration)

Overview

The interface for AR session configurations. More…

interface IARConfiguration: IDisposable {
    // properties

    bool IsLightEstimationEnabled;
    ReadOnlyCollection<IARVideoFormat> SupportedVideoFormats;
    IARVideoFormat VideoFormat;
    WorldAlignment WorldAlignment;

    // methods

    void CopyTo(IARConfiguration target);
};

// direct descendants

interface IARWorldTrackingConfiguration;

Detailed Documentation

The interface for AR session configurations.

Note

You will not create or work with instances of this interface. Instead, you create one of the more specialized sub-classes. In order to run an AR session, you must pass in a configuration (one of these sub-classes) that most matches the type of AR experience you wish to provide with your app or game.

Properties

bool IsLightEstimationEnabled

A boolean specifying whether or not camera images are analyzed to estimate scene lighting.

ReadOnlyCollection<IARVideoFormat> SupportedVideoFormats

Returns a collection of supported video formats by this configuration and device.

Note

iOS-only value.

Note

Not supported in Virtual Studio.

IARVideoFormat VideoFormat

A value specifying the options to use for the output video stream.

Note

This is an iOS-only value.

Note

May be null depending on system version.

WorldAlignment WorldAlignment

A value specifying how the session maps the real-world device motion into a coordinate system.

Note

This is an iOS-only value.

Methods

void CopyTo(IARConfiguration target)

Copies the values of this configuration into the target configuration.