Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/videosdk-live/videosdk-rtc-ios-sdk-example

WebRTC based video conferencing SDK for iOS (Swift / Objective C)
https://github.com/videosdk-live/videosdk-rtc-ios-sdk-example
chat ios realtime sdk swift video webrtc
Last synced: 3 months ago
JSON representation
WebRTC based video conferencing SDK for iOS (Swift / Objective C)
Host: GitHub
URL: https://github.com/videosdk-live/videosdk-rtc-ios-sdk-example
Owner: videosdk-live
Created: 2021-09-15T10:08:56.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-11-20T11:33:40.000Z (3 months ago)
Last Synced: 2024-11-20T11:37:03.593Z (3 months ago)
Topics: chat, ios, realtime, sdk, swift, video, webrtc
Language: Swift
Homepage: https://docs.videosdk.live/docs/realtime-communication/sdk-reference/ios-sdk/setup
Size: 93 MB
Stars: 12
Watchers: 2
Forks: 5
Open Issues: 3
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        # Video SDK for iOS

[![Documentation](https://img.shields.io/badge/Read-Documentation-blue)](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/getting-started)

[![Firebase](https://img.shields.io/badge/Download%20Android-Firebase-green)](https://appdistribution.firebase.dev/i/a4c63049415c4356)

[![TestFlight](https://img.shields.io/badge/Download%20iOS-TestFlight-blue)](https://testflight.apple.com/join/LYj3QJPx)

[![Discord](https://img.shields.io/discord/876774498798551130?label=Join%20on%20Discord)](https://discord.gg/bGZtAbwvab)

[![Register](https://img.shields.io/badge/Contact-Know%20More-blue)](https://app.videosdk.live/signup)

At Video SDK, we’re building tools to help companies create world-class collaborative products with capabilities of live audio/videos, compose cloud recordings/rtmp/hls and interaction APIs

## Demo App

📲 Download the Sample iOS app here: https://testflight.apple.com/join/26EBZkcX




## Meeting Features

- [x] Real-time video and audio conferencing

- [x] Enable/disable camera

- [x] Mute/unmute mic

- [x] Chat

- [x] Raise hand

- [x] Recording




## Setup Guide

- Sign up on [VideoSDK](https://app.videosdk.live/) and visit [API Keys](https://app.videosdk.live/api-keys) section to get your API key and Secret key.

- Get familiarized with [API key and Secret key](https://docs.videosdk.live/ios/guide/video-and-audio-calling-api-sdk/signup-and-create-api)

- Get familiarized with [Token](https://docs.videosdk.live/ios/guide/video-and-audio-calling-api-sdk/server-setup)




### Prerequisites

- iOS 12.0+

- Xcode 13.0+

- Swift 5.0+

- Valid [Video SDK Account](https://app.videosdk.live/signup)

## Run the Sample App

### Step 1: Clone the sample project

   ```sh

   git clone https://github.com/videosdk-live/videosdk-rtc-ios-sdk-example.git

   ```

### Step 2. Install Pods

Run `pod install` in terminal from the Example project directory.

### Step 3. update `AUTH_TOKEN` in the `Constants.swift` file.

Generate temporary token from [Video SDK Account](https://app.videosdk.live/signup).

   ```

   public let AUTH_TOKEN = "#YOUR_GENERATED_TOKEN"

   ```

### Step 4. Run the project.

Run App from Xcode. Please run the app in real device for better experience because audio and video is not supported in simulator.




## Key Concepts

- `Meeting` - A Meeting represents Real time audio and video communication.

  **`Note : Don't confuse with Room and Meeting keyword, both are same thing 😃`**

- `Sessions` - A particular duration you spend in a given meeting is a referred as session, you can have multiple session of a particular meetingId.

- `Participant` - Participant represents someone who is attending the meeting's session, `local partcipant` represents self (You), for this self, other participants are `remote participants`.

- `Stream` - Stream means video or audio media content that is either published by `local participant` or `remote participants`.




## Permissions

- Your app needs to add permissions to use microphone and camera. Add below code your app's info.plist.

```swift

NSCameraUsageDescription

Allow camera access to start video.

NSMicrophoneUsageDescription

Allow microphone access to start audio.

```




## Token Generation

Token is used to create and validate a meeting using API and also initialise a meeting.

🛠️ `Development Environment`:

- You may use a temporary token for development. To create a temporary token, go to VideoSDK [dashboard](https://app.videosdk.live/api-keys) .

🌐 `Production Environment`:

- You must set up an authentication server to authorise users for production. To set up an authentication server, refer to our official example repositories. [videosdk-rtc-api-server-examples](https://github.com/videosdk-live/videosdk-rtc-api-server-examples)




## API: Create and Validate meeting

- `create meeting` - Please refer this [documentation](https://docs.videosdk.live/api-reference/realtime-communication/create-room) to create meeting.

- `validate meeting`- Please refer this [documentation](https://docs.videosdk.live/api-reference/realtime-communication/validate-room) to validate the meetingId.




## [Initialize a Meeting](https://docs.videosdk.live/ios/api/sdk-reference/setup)

- You can initialize the meeting using `VideoSDK.initMeeting` method. this method configures meeting with given meeting-id.

```swift

    VideoSDK.config(token: "server-token")

    meeting = VideoSDK.initMeeting(

        meetingId: "meeting-id",

        participantId: "participant-id"

        participantName: "participant-name",

        micEnabled: true,

        webcamEnabled: true,

      )

```




## [Enable/Disable Local Webcam](https://docs.videosdk.live/ios/api/sdk-reference/meeting-class/methods)

```swift

    buttonControlsView.onVideoTapped = { on in

        

        if !on {

            self.meeting?.enableWebcam()

        } else {

            self.meeting?.disableWebcam()

        }

    }

```




## [Mute/Unmute Local Audio](https://docs.videosdk.live/ios/api/sdk-reference/meeting-class/methods)

```swift

    buttonControlsView.onMicTapped = { on in

        if !on {

            self.meeting?.unmuteMic()

        } else {

            self.meeting?.muteMic()

        }

    }

```




## [Change Local Mic](https://docs.videosdk.live/ios/api/sdk-reference/meeting-class/methods)

```swift

    AVAudioSession.sharedInstance().changeAudioOutput(presenterViewController: self)

```




## [Chat](https://docs.videosdk.live/ios/api/sdk-reference/meeting-class/pubsub)

- The chat feature allows participants to send and receive messages about specific topics to which they have subscribed.

```swift

    // listen/subscribe for chat topic

    meeting?.pubsub.subscribe(topic: CHAT_TOPIC, forListener: self)

    

    //write this block on click event

    meeting.pubSub.publish(topic: "CHAT", message: message, options: { persist: true })

    

    //unsubscribing messages on topic CHAT

    meeting.pubSub.unsubscribe("CHAT");

```




## Raise Hand

- This feature allows participants to raise hand during the meeting.

```swift

    // listen/subscribe for raise-hand topic

    meeting?.pubsub.subscribe(topic: RAISE_HAND_TOPIC, forListener: self);

    

    // raise hand on click event

    self.meeting?.pubsub.publish(topic: RAISE_HAND_TOPIC, message: "Raise Hand by Me", options: [:])

```




## [Recording](https://docs.videosdk.live/ios/api/sdk-reference/meeting-class/methods)

- Record meeting allows participants to record video & audio during the meeting. The recording files are available in developer dashboard. Any participant can start / stop recording any time during the meeting.

```swift

    let webhookUrl = "https://webhook.your-api-server.com"

    

    // start recording

    meeting.startRecording(webhookUrl: webhookUrl)

    

    // stop recording

    stopRecording()

```




## [Live Streaming](https://docs.videosdk.live/ios/api/sdk-reference/meeting-class/methods)

- Interactive Live Streaming allows participants to to broadcast live streaming to other participants. Host can start / stop HLS any time during the meeting.

```swift

    // start live streaming

    startLivestream(outputs: outputs)

    

    // stop live streaming

    stopLivestream()

```




## [Leave or End Meeting](https://docs.videosdk.live/ios/api/sdk-reference/meeting-class/methods)

```swift

  // Only one participant will leave/exit the meeting; the rest of the participants will remain.

  meeting?.leave();

  // The meeting will come to an end for each and every participant. So, use this function in accordance with your requirements.

  meeting?.end();

```




## [Meeting Event callbacks](https://docs.videosdk.live/ios/api/sdk-reference/meeting-class/methods)

By registering callback handlers, VideoSDK sends callbacks to the client app whenever there is a change or update in the meeting after a user joins.

```swift

func onMeetingJoined() {

  // This event will be emitted when a localParticipant(you) successfully joined the meeting.

  print("onMeetingJoined");

}

func onMeetingLeft() {

  // This event will be emitted when a localParticipant(you) left the meeting.

  print("onMeetingLeft");

}

func onParticipantJoined(participant) {

  // This event will be emitted when a new participant joined the meeting.

  // [participant]: new participant who joined the meeting

  print(" onParticipantJoined", participant);

}

func onParticipantLeft(participant) {

  // This event will be emitted when a joined participant left the meeting.

  // [participantId]: id of participant who left the meeting

  print(" onParticipantLeft", participant);

}

func onSpeakerChanged = (activeSpeakerId) => {

  // This event will be emitted when any participant starts or stops screen sharing.

  // [activeSpeakerId]: Id of participant who shares the screen.

  print(" onSpeakerChanged", activeSpeakerId);

};

func onRecordingStarted() {

  // This event will be emitted when recording of the meeting is started.

  print(" onRecordingStarted");

}

func onRecordingStopped() {

  // This event will be emitted when recording of the meeting is stopped.

  print(" onRecordingStopped");

}

```




## [Participant Events Callback](https://docs.videosdk.live/ios/api/sdk-reference/meeting-class/methods)

By registering callback handlers, VideoSDK sends callbacks to the client app whenever a participant's video, audio, or screen share stream is enabled or disabled.

```swift

  func onStreamEnabled(stream, participant) {

    // This event will be triggered whenever a participant's video, audio or screen share stream is enabled.

    print("onStreamEnabled");

  }

  func onStreamDisabled(stream, participant) {

    // This event will be triggered whenever a participant's video, audio or screen share stream is disabled.

    print(" onStreamDisabled");

  }

```

If you want to learn more about the SDK, read the Complete Documentation of [iOS VideoSDK](https://docs.videosdk.live/ios/api/sdk-reference/setup)




## Project Description




> **Note :**

>

> - **main** branch: Better UI with One-to-One and Conference call experience.

> - **v1-sample-code** branch: Simple UI with Group call experience.




## Project Structure

We have separated conrtroller and components in following folder structure:

```

VideoSDK

└── view

    └── ButtonControlsView.swift

    └── ParticipantCellView.swift

└── API

    └── Constants.swift

    └── APIService.swift

└── models

    └── Message.swift

    └── ChatUser.swift

    └── MeetingData.swift

└── controllers

    └── StartMeetingViewController.swift

    └── MeetingViewController.swift

    └── ChatViewController.swift

```




## Examples 

### Examples for Conference

- [videosdk-rtc-prebuilt-examples](https://github.com/videosdk-live/videosdk-rtc-prebuilt-examples)

- [videosdk-rtc-javascript-sdk-example](https://github.com/videosdk-live/videosdk-rtc-javascript-sdk-example)

- [videosdk-rtc-react-sdk-examplee](https://github.com/videosdk-live/videosdk-rtc-react-sdk-example)

- [videosdk-rtc-react-native-sdk-example](https://github.com/videosdk-live/videosdk-rtc-react-native-sdk-example)

- [videosdk-rtc-flutter-sdk-example](https://github.com/videosdk-live/videosdk-rtc-flutter-sdk-example)

- [videosdk-rtc-android-java-sdk-example](https://github.com/videosdk-live/videosdk-rtc-android-java-sdk-example)

- [videosdk-rtc-android-kotlin-sdk-example](https://github.com/videosdk-live/videosdk-rtc-android-kotlin-sdk-example)

- [videosdk-rtc-ios-sdk-example](https://github.com/videosdk-live/videosdk-rtc-ios-sdk-example)

### Examples for Live Streaming

- [videosdk-hls-react-sdk-example](https://github.com/videosdk-live/videosdk-hls-react-sdk-example)

- [videosdk-hls-react-native-sdk-example](https://github.com/videosdk-live/videosdk-hls-react-native-sdk-example)

- [videosdk-hls-flutter-sdk-example](https://github.com/videosdk-live/videosdk-hls-flutter-sdk-example)

- [videosdk-hls-android-java-example](https://github.com/videosdk-live/videosdk-hls-android-java-example)

- [videosdk-hls-android-kotlin-example](https://github.com/videosdk-live/videosdk-hls-android-kotlin-example)

## Documentation

[Read the documentation](https://docs.videosdk.live/) to start using Video SDK.

## Community

- [Discord](https://discord.gg/Gpmj6eCq5u) - To get involved with the Video SDK community, ask questions and share tips.

- [Twitter](https://twitter.com/video_sdk) - To receive updates, announcements, blog posts, and general Video SDK tips.