このトピックでは、ApsaraVideo Player SDK for iOSを統合する方法について説明します。
環境要件
項目 | 説明 |
オペレーティングシステム | iOS 8.0以降。 |
开発ツール | Xcodeを使用することを推奨します。 このトピックで説明する手順は、Xcodeに基づいています。 Xcodeをダウンロードするには、Mac App Storeにアクセスしてください。 |
前提条件
ApsaraVideo Player SDKのライセンスが登録され、ライセンスファイル
AliVideoCert-********.crt
が取得されます。 詳細については、「ライセンスの取得」をご参照ください。ApsaraVideo Player SDK for iOSのパッケージとデモのソースコードがダウンロードされます。 SDKとデモの最新バージョンをダウンロードすることを推奨します。 ダウンロードリンクの詳細については、「SDKの概要とダウンロード」をご参照ください。
次の表に、パッケージが解凍された後のSDKパッケージ内のフォルダーまたはファイルを示します。
フォルダまたはファイル | 説明 |
demo | ApsaraVideo Player SDK for iOSのデモのソースコード。 |
doc | ApsaraVideo Player SDK for iOSのAPIリファレンス。 |
sdk | ApsaraVideo Player SDK for iOSのフレームワーク。 デフォルトでは、ARM_SIMULATORフォルダのみが提供されます。 ARM_SIMULATORフォルダには、ビットコードとシミュレータが含まれます。 ビットコードを有効にしない場合、またはシミュレーターを必要としない場合は、次のコマンドを実行して、対応するSDKファイルを生成およびダウンロードします。
|
ReleaseNote | ApsaraVideo Player SDK for iOSのリリースノート。 |
次の表に、sh createMoreKindsOfArch.sh
コマンドを実行した後に生成されるファイルを示します。
ファイル | 説明 |
ARM | ビットコードを含むがシミュレータを含まないフォルダ。 |
ARM_NO_BITCODE | ビットコードまたはシミュレータを含まないフォルダ。 |
ARM_SIMULATOR | ビットコードとシミュレータを含むフォルダ。 |
次の表に、フレームワークファイルを示します。
フレームワーク | 説明 |
alivcffmpeg.framework | プレイヤーの根本的な依存関係として機能するフレームワーク。 このフレームワークが必要です。 |
AliyunMediaDownloader.framework | オフラインダウンロードのフレームワーク。 このフレームワークはオプションです。 |
AliyunPlayer.framework | プレイヤーフレームワーク。 このフレームワークが必要です。 |
artcSource.framework | Alibaba Real-Time Communication (ARTC) プロトコルをサポートするAARパッケージ。 このパッケージはオプションです。 |
artpSource.framework | Alibaba Real-time Transport Protocol (ARTP) プロトコルをサポートするAARパッケージ。 このパッケージはオプションです。 このフレームワークへの依存関係は、ApsaraVideo Player SDK for iOS V5.4.5.0では削除されます。 |
RtsSDK.framework | RTSをサポートするフレームワーク。 このフレームワークはオプションです。 |
AlivcConan | このフレームワークへの依存関係は、ApsaraVideo Player SDK for iOS V5.3.0では削除されます。 |
使用上の注意
アプリケーションファイルをパッケージ化すると、dSYMファイルがクラッシュレポートのシンボル化に使用されます。
ApsaraVideo Player SDK for iOSを使用する場合は、AlivcFFmpegとAliyunPlayerが必要です。 AliyunPlayer.frameworkのディレクトリでヘッダーファイルを表示できます。
ショートビデオSDKとApsaraVideo Player SDKの両方を統合する場合は、AlivcFFmpegの正しいバージョンをインポートしてください。 それ以外の場合は、ショートビデオSDKまたはApsaraVideo Player SDKによって提供される機能を使用できません。 詳細については、「AlivcFFmpeg依存関係」をご参照ください。
ApsaraVideo Player SDK for iOSの特定の機能は、シミュレーターで期待どおりに実行されない場合があります。 ApsaraVideo Player SDK for iOSを統合した後、デバッグにiPhoneを使用することを推奨します。
シミュレーターは、ApsaraVideo Player SDK for iOSのインストールパッケージに含まれています。 シミュレータを使用してコードをデバッグできます。 アプリケーションを公開する場合は、シミュレータを含むSDKを使用しないでください。 そうしないと、アプリケーションがApp Storeに送信されない可能性があります。
CocoaPodsを使用したSDKの統合 (推奨)
CocoaPodsステートメントを使用して、ApsaraVideo Player SDK for iOSを統合します。 サンプルコード:
説明ショートビデオSDKとApsaraVideo Player SDKの両方を統合する場合は、次のコードの
AliPlayerSDK_iOS
をAliPlayerPartSDK_iOS
に置き換えます。AliPlayerPartSDK_iOS
にはFFmpegフレームワークは含まれていません。 これにより、iOS用の短いビデオSDKのFFmpegフレームワークとの競合が防止されます。ruby platform:ios, '8.0' target 'yourProject' do pod 'AliPlayerSDK_iOS' end
オプション: プレイヤーがARTCプロトコルをサポートするか、RTSストリームを再生する場合は、必要に応じてポッドの依存関係を追加します。 サンプルコード:
説明SDKのバージョン番号が正しいことを確認してください。 それ以外の場合、エラーが報告され、依存関係の追加に失敗します。
ruby platform:ios, '8.0' target 'yourProject' do pod 'AliPlayerSDK_iOS', '5.4.7.1' pod 'AliPlayerSDK_iOS_ARTC', '5.4.7.1' pod 'RtsSDK', '2.2.0' // This version number is for reference only. For more information about the latest version of the RTS SDK, see Download SDKs. end
ローカルファイルを追加してSDKを統合する
ショートビデオSDKとApsaraVideo Player SDKの両方を統合する場合は、AlivcFFmpegが1つだけ必要です。 AlivcFFmpegの正しいバージョンをインポートしてください。
Xcodeプロジェクトで、一般タブをクリックします。
ApsaraVideo Player SDK for iOSのフレームワークを [フレームワーク、ライブラリ、および埋め込みコンテンツ] セクションに追加します。 これらのフレームワークの [埋め込み] 列で [埋め込みと署名] を選択します。
ビルド設定タブをクリックします。
検索パスセクションで、フレームワーク検索パスパラメータをフレームワークファイルが格納されるパスに設定します。
ライセンスの設定
ApsaraVideo Player SDK for iOS V5.4.7.1以降のバージョンのライセンスを設定するには、SDKを使用する前に、次の操作を実行する必要があります。
ApsaraVideo Player SDK for Androidは無料で使用できます。 SDKライセンスの有効期間は1年です。 デフォルトでは、ライセンスの有効期限が切れると、システムは自動的に無料でライセンスを更新します。 SDKライセンスが更新されると、システムはローカル証明書を更新します。 新しいバージョンのアプリケーションを公開するときは、最新のローカル証明書を統合することをお勧めします。 ApsaraVideo VODコンソールで最新の証明書を取得できます。 詳細については、「Manage licenses」をご参照ください。
ライセンスを設定したら、ログを確認します。 ライセンス関連のエラーが報告されない場合、ライセンスは正しく構成されています。
設定されたライセンスファイルとライセンスキーは、BundleIDで指定されたアプリケーションで使用する必要があります。 ライセンスファイルまたはライセンスキーがアプリケーションと一致しない場合、認証は失敗します。
Xcodeプロジェクトで、
を選択します。 次に、ライセンスファイルAliVideoCert-********.crt
をXcodeプロジェクトにコピーします。 AppSupportFilesディレクトリにファイルを保存することを推奨します。 サンドボックスディレクトリまたは他のディレクトリに配置することもできます。Info.plistファイルに次のフィールドを追加します。
最初のキーを
AlivcLicenseKey
に設定し、値をLicenseKeyの値に設定します。2番目のキーを
AlivcLicenseFile
に設定し、値をライセンスファイルが保存されているパスに設定します。
<key>AlivcLicenseKey</key> <string>Wo8s*******************</string> <key>AlivcLicenseFile</key> <string>license.crt</string>
よくある質問
プロジェクトでサードパーティSDKを参照しているときに、AlivcFFmpegまたはAlivcConanの競合が存在することを示すエラーメッセージが返された場合はどうすればよいですか?
解決策:
AlivcConanのシンボルとの競合: V5.3.0以降ではAlivcConanが不要になったため、リンクされたフレームワークとライブラリからAlivcConanを削除します。 AlivcConanは、アプリケーションリンクのオプションです。
AlivcFFmpegのシンボルとの競合: AlivcFFmpegを1つだけ保持し、余分なAlivcFFmpeg依存関係を削除します。 AlivcFFmpegは、FFmpegに基づいてAlibaba Cloudによって開発されたカスタム依存関係であり、ApsaraVideo Player SDKの主要部分です。 サードパーティSDKのAlivcFFmpeg依存関係を削除し、ApsaraVideo Player SDKのAlivcFFmpeg依存関係を保持することを推奨します。 ただし、これはサードパーティのプレーヤーにエラーを引き起こす可能性があります。
ApsaraVideo Player SDKおよび対応するソリューションを使用するときに発生する可能性のある問題の詳細については、 「プレイヤーに関するFAQ」をご参照ください。