OpenTok iOS SDK-Referenz
Das OpenTok-iOS-SDK enthält die folgenden Klassen:
| Klasse | Beschreibung |
|---|---|
| OTAudioBus | Der Audiobus leitet Audiodaten zwischen dem Netzwerk und dem Audiogerät weiter. Rufen Sie die Methode [OTAudioDevice setAudioBus:] auf, um das Objekt zu definieren, das das OTAudioBus-Protokoll implementiert. Das Audiogerät überträgt erfasste Audio-Samples an den Audiobus und ruft noch nicht gerenderte Audio-Samples vom Audiobus ab. |
| OTAudioData | Definiert die Audiodaten, die an die Methode [OTCustomAudioTransformer transform:] übergeben werden. |
| OTAudioDevice | Definiert ein Audiogerät zur Verwendung in einer Sitzung. Siehe [OTAudioDeviceManager setAudioDevice:]. |
| OTAudioDeviceManager | Verwenden Sie den AudioDeviceManager, um ein benutzerdefiniertes Audiogerät festzulegen, das von der App verwendet werden soll. Das Audiogerät verwaltet den Zugriff auf die Hardware für die Audioaufnahme und -wiedergabe. |
| OTAudioFormat | Legt das Audioformat fest, wenn ein benutzerdefinierter Audiotreiber verwendet wird. |
| OTAudioSessionManager | Definiert einen Audio-Session-Manager zur Verwendung mit Anrufdiensten wie CallKit. Die Implementierung dieses Protokolls ist optional. Benutzerdefinierte Audiogeräte können diese Methoden implementieren, um die AVAudioSession zu verwalten. Das Standard-Audiogerät im SDK bietet eine funktionsfähige Implementierung. |
| OTAudioTransformer | Definiert einen Transformator für einen Audiostream. |
| OTCameraCaptureFrameRate | Legt Werte für den Parameter „cameraFrameRate“ der Methode [OTPublisher initWithDelegate:name:cameraResolution:cameraFrameRate:] fest. |
| OTCameraCaptureResolution | Legt Werte für den Parameter „cameraResolution“ der Methode [OTPublisher initWithDelegate:name:cameraResolution:cameraFrameRate:] fest. |
| OTConnection | Stellt eine Verbindung zu einer OpenTok-Sitzung dar. Die Klasse „OTSession“ enthält eine „connection“-Eigenschaft, bei der es sich um ein „OTConnection“-Objekt handelt. Auch die Klasse „OTStream“ enthält eine „connection“-Eigenschaft, bei der es sich um ein „OTConnection“-Objekt handelt. |
| OTCustomAudioTransformer | Definiert einen benutzerdefinierten Transformator für einen Audiostream, der an die Methode [OTAudioTransformer initWithName:transformer:] übergeben werden soll. |
| OTCustomVideoTransformer | Definiert einen benutzerdefinierten Transformator für einen Videostream, der an die Methode [OTVideoTransformer initWithName:transformer:] übergeben werden soll. |
| OT-Abbaupräferenz | Standardwert. Die Video-Engine legt die optimale Einstellung für die Qualitätsreduzierung fest. |
| OTError | Definiert Fehler für das OpenTok iOS SDK. |
| OTMuteForcedInfo | Definiert den Parameter „muteForced“ der Nachricht [OTSessionDelegate session:muteForced:]. |
| OT-Netzwerkzustand | Geschätzter Netzwerkzustandswert für einen Transport. |
| OT-Netzwerk-Leistungsminderung-Quelle | Zeigt die Ursache für eine Verschlechterung der Video- oder Netzwerkqualität in der Sitzung an. |
| OT-Netzwerk-Grund | Beschreibt den Hauptgrund, der den Netzwerkzustand beeinflusst. |
| OTPixelFormat | Legt Werte für das Pixelformat der Eigenschaft „pixelFormat“ eines OTVideoFrame-Objekts fest. |
| OTPublisher | Ein Publisher erfasst einen Audio-Video-Stream vom Mikrofon und der Kamera des Geräts. Anschließend können Sie den Audio-Video-Stream in einer OpenTok-Sitzung veröffentlichen, indem Sie die Nachricht [OTSession publish:error:] senden. |
| OTPublisherDelegate | Wird zum Senden von Nachrichten für eine OTPublisher-Instanz verwendet. |
| OTPublisherErrorCode | Auflistung der Fehlercode-Werte, die von [OTPublisherKitDelegate publisher:didFailWithError:] verwendet werden. |
| OTPublisherKit | Ein Publisher erfasst einen Audio-Video-Stream aus den von Ihnen angegebenen Quellen. Anschließend können Sie den Audio-Video-Stream in einer OpenTok-Sitzung veröffentlichen, indem Sie die Nachricht [OTSession publish:error:] senden. |
| OTPublisherKitAudioLevelDelegate | Dient zur Überwachung der Audiopegel des Herausgebers. |
| OTPublisherKitAudioNetzwerkstatistiken | Beschreibt die Audio-Statistiken für einen Publisher. Siehe [OTPublisherKit setNetworkStatsDelegate:]. |
| OTPublisherKitDelegate | Wird zum Senden von Nachrichten an eine OTPublisher-Instanz verwendet. Die OTPublisher-Klasse enthält eine Delegate-Eigenschaft. Wenn Sie die Nachricht [OTPublisherKit initWithDelegate:] oder die Nachricht [OTPublisherKit initWithDelegate:settings:] senden, geben Sie ein OTPublisherKitDelegate-Objekt an. |
| OTPublisherKitMediaLinkStats | Stellt Statistiken zu den Medien-Links der Publisher bereit, einschließlich Kennzahlen zum lokalen Datenverkehr. |
| OTPublisherKitNetworkStatsDelegate | Dient zur Überwachung der Audio- und Videostatistiken für den Publisher. Siehe [OTPublisherKit networkStatsDelegate]. |
| OTPublisherKitRtcStatsReportDelegate | Wird zum Senden von Nachrichten verwendet, die RTC-Statistiken des Herausgebers melden. Setzen Sie die Eigenschaft [OTPublisherKit rtcStatsReportDelegate], um diesen Delegaten zu verwenden. Nachdem Sie die Methode [OTPublisherKit getRtcStatsReport] aufgerufen haben, wird die Nachricht [OTPublisherKitRtcStatsReportDelegate publisher:rtcStatsReport:] gesendet, um die |
| OTPublisherKitEinstellungen | Legt die Einstellungen fest, die bei der Initialisierung eines Publishers mithilfe der Methode [OTPublisherKit initWithDelegate:settings:] verwendet werden sollen. |
| OTPublisherKitVideoLayerStats | Beschreibt die Statistiken für eine einzelne veröffentlichte Videoebene. |
| OTPublisherKitVideoNetzwerkstatistiken | Beschreibt die Videostatistiken für einen Publisher. Siehe [OTPublisherKit setNetworkStatsDelegate:]. |
| OTPublisherKitVideoType | Legt Werte für die Eigenschaft [OTPublisherKit videoType] fest. |
| OTPublisherRtcStats | Stellt die RTC-Statistiken für einen vom Herausgeber veröffentlichten Medienstrom dar. |
| OTPublisherEinstellungen | Legt die Einstellungen fest, die bei der Initialisierung eines Publishers mithilfe der Methode [OTPublisher initWithDelegate:settings:] verwendet werden sollen. |
| OTPublisherVideoEventGrund | Ereignisse, bei denen die Videowiedergabe aktiviert oder deaktiviert wurde, sind mit einem Grundcode versehen, anhand dessen sich feststellen lässt, warum die Videospur aktiviert bzw. deaktiviert wurde. |
| OTSenderStats | Stellt von der Senderseite gemeldete Videostatistiken dar, wie beispielsweise Schätzungen der Bitrate. |
| OTSession | Der erste Schritt bei der Verwendung des OpenTok-iOS-SDK besteht darin, ein OTSession-Objekt mit Ihrem API-Schlüssel und einer gültigen Sitzungs-ID zu initialisieren. Verwenden Sie das OTSession-Objekt, um mithilfe Ihres Entwickler-API-Schlüssels und eines gültigen Tokens eine Verbindung zu OpenTok herzustellen. |
| OTSessionCapabilities | Definiert die Eigenschaft [OTSession capabilities]. Nachdem Sie eine Verbindung zu einer Sitzung hergestellt haben und die Methode [OTSessionDelegate sessionDidConnect:] aufgerufen wurde, gibt diese Eigenschaft an, ob der Client Streams in der Sitzung veröffentlichen und abonnieren kann, basierend auf der Rolle, die dem verwendeten Token zugewiesen wurde, um |
| OTSessionConnectionStatus | Die Verbindungsstatuscodes, die über [OTSession sessionConnectionStatus] abgerufen werden können. |
| OTSessionDelegate | Wird zum Senden von Nachrichten für eine OTSession-Instanz verwendet. Die OTSession-Klasse enthält eine Delegate-Eigenschaft. Wenn Sie die Nachricht [OTSession initWithApiKey:sessionId:delegate:] senden, geben Sie ein OTSessionDelegate-Objekt an. |
| OTSessionFehlercode | Auflistung der Fehlercode-Werte, die von [OTSessionDelegate session:didFailWithError:] verwendet werden. |
| OTSessionICEConfig | Definiert die Eigenschaft. Hiermit werden die TURN-Server festgelegt, die vom Client während der Sitzung verwendet werden sollen. |
| OTSessionICEIncludeServers | Legt fest, ob ausschließlich Ihre benutzerdefinierten TURN-Server verwendet werden sollen oder ob diese Server zusätzlich zu den OpenTok-TURN-Servern zum Einsatz kommen sollen. Legt Werte für die Eigenschaft fest. |
| OTSessionICETransportPolicy | Legt fest, ob alle ICE-Transporttypen (wie z. B. „host“, „srflx“ und „TURN“) zum Aufbau der Medienverbindung verwendet werden sollen oder ob ausschließlich „TURN“ zum Einsatz kommt. Wird in der Einstellung [OTSessionICEConfig transportPolicy] verwendet. |
| OTSessionEinstellungen | Legt die Einstellungen fest, die bei der Initialisierung eines OTSession-Objekts mithilfe der Methode [OTSession initWithApiKey:sessionId:delegate:settings:] verwendet werden sollen. |
| OTStream | Ein OTStream-Objekt repräsentiert einen Multimedia-Stream, der Video- und/oder Audiodaten enthalten kann. |
| OTStreamVideoType | Legt Werte für die Eigenschaft [OTStream videoType] fest. |
| OTS-Abonnent | Stellt OpenTok-Streams dar und bietet eine UIView, die Videos anzeigt und einige einfache Steuerelemente für den Endbenutzer bereitstellt. |
| OTSubscriberDelegate | OTSubscriberDelegate erweitert OTSubscriberKitDelegate um zusätzliche optionale Callbacks, die spezifisch für die OTSubscriber-Implementierung sind. Derzeit gibt es nur einen zusätzlichen Callback, doch in einer zukünftigen Version könnten weitere hinzukommen. |
| OTSubscriberErrorCode | Aufzählungen der Fehlercode-Werte, die von [OTSubscriberKitDelegate subscriber:didFailWithError:] verwendet werden. |
| OTSubscriberKit | Ein OTSubscriberKit-Objekt (Subscriber) rendert an einen OTStream gebundene Mediendaten. Mit der Klasse OTSubscriberKit können Sie einen benutzerdefinierten Video-Renderer für den Videostream festlegen. Verwenden Sie diese Klasse, wenn Sie eine eigene Implementierung für die Videoverarbeitung und das Rendering bereitstellen möchten. Andernfalls verwenden Sie das OTSubscri |
| OTSubscriberKitAudioLevelDelegate | Dient zur Überwachung der Audiopegel des Teilnehmers. |
| OTSubscriberKitAudioNetworkStats | Beschreibt die Audio-Statistiken für einen Teilnehmer. Siehe [OTSubscriberKit setNetworkStatsDelegate:]. |
| OTSubscriberKitCaptionsDelegate | Wird zum Empfang von Untertiteln für den Stream eines Abonnenten verwendet. |
| OTSubscriberKitDelegate | Wird zum Senden von Nachrichten an eine OTSubscriber-Instanz verwendet. Beim Senden der Nachricht [OTSubscriberKit initWithStream:delegate:] geben Sie ein OTSubscriberKitDelegate-Objekt an. |
| OTSubscriberKitMediaLinkStats | Stellt Statistiken zu den Medienverbindungen der Teilnehmer bereit, einschließlich Kennzahlen zum lokalen und entfernten Transport sowie Informationen zu Netzwerkbeeinträchtigungen. |
| OTSubscriberKitNetworkStatsDelegate | Dient zur Überwachung der Audio- und Videostatistiken für den Teilnehmer. Siehe [OTSubscriberKit networkStatsDelegate]. |
| OTSubscriberKitRtcStatsReportDelegate | Wird zum Senden von Nachrichten verwendet, die RTC-Statistiken des Abonnenten melden. Setzen Sie die Eigenschaft [OTSubscriberKit rtcStatsReportDelegate], um diesen Delegaten zu verwenden. Nachdem Sie die Methode [OTSubscriberKit getRtcStatsReport] aufgerufen haben, wird die Nachricht [OTSubscriberKitRtcStatsReportDelegate subscriber:rtcStatsReport:] an „repo“ gesendet. |
| OT-Abonnenten-Kit-Video-Netzwerk-Statistiken | Beschreibt die Videostatistiken für einen Abonnenten. Siehe [OTSubscriberKit setNetworkStatsDelegate:]. |
| OTSubscriberVideoEventReason | Ereignisse, bei denen die Videowiedergabe aktiviert oder deaktiviert wurde, sind mit einem Grundcode versehen, anhand dessen sich feststellen lässt, warum die Videospur aktiviert bzw. deaktiviert wurde. |
| OTTransportStats | Stellt Transportstatistiken auf Netzwerkebene bereit. |
| OTVideoBitratePreset | Voreingestellte Strategien zur Steuerung der Video-Bitrate im Stream eines Anbieters. |
| OTVideoCapture | Definiert einen Video-Capturer, der von einem OTPublisherKit-Objekt verwendet werden soll. Siehe die Eigenschaft „videoCapture“ eines OTPublisherKit-Objekts. |
| OTVideoCaptureConsumer | Definiert einen Verbraucher eines OTVideoCapture-Objekts. |
| OTVideoCodecPreference | @class OTVideoCodecPreference |
| OTVideoCodecType | Legen Sie Werte für die Eigenschaft [OTVideoCodecPreference codecs] sowie für die Elemente im Array fest, das von der Methode [OTVideoCodecPreference manualWithCodecs:] verwendet wird. |
| OTVideoContentHint | Legt Werte für die Methode fest. |
| OTVideoFormat | Legt das Videoformat fest, das einer Instanz eines OTVideoFrame-Objekts zugewiesen ist. |
| OTVideoFrame | Definiert einen Videobild. Siehe [OTVideoRender renderVideoFrame:] und [OTVideoCaptureConsumer consumeFrame:]. |
| OTVideoAusrichtung | Definiert Werte für die Videoausrichtung (oben, unten, links, rechts) für die Eigenschaft „orientation“ eines OTVideoFrame-Objekts. |
| OTVideoRender | Definiert einen Video-Renderer, der von einem OTPublisherKit-Objekt oder einem OTSubscriberKit-Objekt verwendet wird. Siehe die videoRender-Eigenschaften des OTPublisherKit-Objekts und des OTSubscriberKit-Objekts. |
| OTVideoTransformer | Definiert einen Transformator für einen Videostream. |
| OTVideoViewScaleBehavior | Legt Werte für die Eigenschaften [OTSubscriber viewScaleBehavior] und [OTPublisher viewScaleBehavior] fest. |