Core Module

78.2.0

Changelog Summary :

Category	Description
Initialization	Added new configure() function for environment and session setup.
Error Handling	isAuthenticated is no longer a function — now a variable property.
API Deprecations	Deprecated old authentication method requiring manual signature.
Authentication	Refactored authentication logic and configuration initialization.

⚠️ Breaking Changes

1. New configure() Initialization Function

A new initialization step has been introduced. Before using any SDK feature, you must explicitly call the new configuration method.

New Required Setup:

TruvideoSdk.configure(with: options)

Purpose:

• Sets up user session and internal SDK configuration.

• Must be invoked before any authentication or SDK module usage.

Impact:

• SDK functions that previously worked without prior setup will now fail if configure() was not called.

• Recommended to call configure() during your app startup (e.g., in AppDelegate or SceneDelegate).

2. isAuthenticated is now a variable

Previous Implementation:

if (try isAuthenticated()) {
    // ...
}

New Implementation:

if (isAuthenticated) {
    // ...
}

Details

• isAuthenticated is no longer a throw function.

• It is now a computed property (or variable) that returns a Boolean authentication state.

• Any previous usage with try or parentheses () must be updated.

• Calling try or using parentheses () will result in a compile-time error.

3. Deprecated Methods

The following methods have been deprecated and will be removed in a future SDK release. They have been replaced with a simplified authentication flow and new configuration accessors. All deprecated methods currently display compiler warnings when used.

3.1 Deprecated Authentication and Session Methods

Deprecated Method	Replacement	Description
authenticate(apiKey:payload:signature:externalId:)	authenticate(apiKey:secretKey:externalId:) function for environment and session setup.	The SDK now handles payload generation and signature computation internally. Developers no longer need to manually build or sign authentication requests.
apiKey()	No longer available	The API key is no longer accessible directly in order to enhance security.
clearAuthentication()	signOut()	Use signOut() to safely clear authentication data and invalidate the session.
generatePayload()	No longer required	The SDK now generates device payloads automatically during authentication.
initAuthentication()	No longer required	Authentication starts automatically when calling authenticate().

3.2 Deprecation Notes:

• These methods continue to work for backward compatibility but are not recommended for new integrations.

• Each deprecated API includes an @available(*, deprecated, message:) annotation with guidance for migration.

• The new authentication model centralizes configuration through TruVideoSdk.configure(with:) and TruVideoSdk.options.

• Future SDK versions may fully remove deprecated methods — migrate to the new API as soon as possible.

✅ Migration Checklist

Before updating to this SDK version:

1. Replace any isAuthenticated() function calls with the isAuthenticated property.

2. Add the required TruvideoSdk.configure() call before any other SDK usage.

3. Update authentication logic to use the new simplified method (secretKey instead of manual payload + signature).

4. Review and update any usage of TruvideoSdkCameraConfiguration to ensure parameters are in the new alphabetical order.

5. Test all authentication and camera configuration flows after migration.

Example: Complete Initialization Flow

import TruvideoSdk

// Step 1: Configure SDK
TruvideoSdk.configure()

// Step 2: Authenticate
TruvideoSdk.authenticate(
    apiKey: "YOUR_API_KEY",
    secretKey: "YOUR_SECRET_KEY",
    externalId: "USER_EXTERNAL_ID"
)

// Step 3: Use SDK Features
if TruvideoSdk.isAuthenticated {
    startRecording()
}