TKRoomSDK Documentation

The TalkCloud SDK for iOS that we provide is packaged as a dynamic framework library. It includes two dynamic libraries: TKRoomSDK.framework and TKMediaEngine.framework.

TKRoomSDK.framework is the classroom interface library. Its main functions include:

Login, logout, room management, whiteboard management, audio and video management, playback management, message management, etc；

It provides a rich set of callback interfaces, which facilitates real-time processing for developers；

TKMediaEngine.framework is the classroom media library. Its main functions include:

Audio and video capture, playback, encoding, decoding, and transmission；

The TKRoomSDK.framework contains the following main header files in the Headers folder:

•  TKRoomSDK.h: Imports all files.

•  TKRoomManager.h: The main interface class file of the SDK.

•  TKRoomDelegate.h: The main delegate callback class file of the SDK.

•  TKDeviceManager.h: Device management class.

•  TKPlaybackManager.h: Playback interface class file.

•  TKPlaybackDelegate.h: Playback delegate callback class file.

•  TKAudioMixer.h: Audio mixing interface file.

•  TKRoomDefines.h: Main related definition class file.

•  TKRoomUser.h: User class interface file.

•  TKServersLog.h: Interface file for printing SDK-related logs.

•  TKRoomWhiteBoardNotification.h: Defines the whiteboard notification message class file.

•  TKUtils.h: Utility class header file.

The TKRoomSDK.h file

You can import all the header files in the TKRoomSDK.framework using #import.

Get the SDK version number:

TKRoomSDKVersionString[]

Call this method to get the SDK version number. The example is as follows:

NSString *sdkVersion = [NSString stringWithFormat:@"%s", TKRoomSDKVersionString];
NSLog(@"TKRoomSDK Version:%@", sdkVersion);

Please refer to the Getting Started example to create an Xcode project and experience the TKRoomSDK.framework.