iOS アプリに高度な機能を追加する

ミッドロール挿入点

iOS Sender SDK は、特定のメディア ストリーム内のミッドロール挿入点とコンパニオン広告をサポートしています。

ミッドロール挿入点の仕組みについて詳しくは、ウェブ レシーバーのミッドロール挿入点の概要をご覧ください。

中断はセンダーとレシーバーの両方で指定できますが、プラットフォーム間で一貫した動作を維持するために、Web ReceiverAndroid TV レシーバーで指定することをおすすめします。

iOS では、GCKAdBreakClipInfoGCKAdBreakInfo を使用して、読み込みコマンドでミッドロール挿入点を指定します。

Swift
let breakClip1Builder = GCKAdBreakClipInfoBuilder(adBreakClipID: "bc0")
breakClip1Builder.title = "Clip title"
if let posterUrl = URL(string: "https://www.some.url") {
  breakClip1Builder.posterURL = posterUrl
}
breakClip1Builder.duration = 60
breakClip1Builder.whenSkippable = 5  // Set this field so that the ad is skippable
let breakClip1 = breakClip1Builder.build()

let breakClip2 = ...
let breakClip3 = ...


let break1 = GCKAdBreakInfoBuilder(adBreakID: "b0", adBreakClipIds: ["bc0", "bc1", "bc2"]).build()
let mediaInfoBuilder = GCKMediaInformationBuilder(entity: "entity")
...
mediaInfoBuilder.adBreaks = [break1]
mediaInfoBuilder.adBreakClips = [breakClip1, breakClip2, breakClip3]
...
mediaInformation = mediaInfoBuilder.build()

let mediaLoadRequestDataBuilder = GCKMediaLoadRequestDataBuilder()
mediaLoadRequestDataBuilder.mediaInformation = mediaInformation

sessionManager.currentSession?.remoteMediaClient?.loadMedia(with: mediaLoadRequestDataBuilder.build())
Objective-C
GCKAdBreakClipInfoBuilder *breakClipInfoBuilder = [[GCKAdBreakClipInfoBuilder alloc] initWithAdBreakClipID:@"bc0"];
breakClipInfoBuilder.title = @"Clip title";
breakClipInfoBuilder.posterURL = [[NSURL alloc] initWithString:@"https://www.some.url"];
breakClipInfoBuilder.duration = 60;
breakClipInfoBuilder.whenSkippable = 5;
GCKAdBreakClipInfo *breakClip1 = breakClipInfoBuilder.build;

GCKAdBreakClipInfo *breakClip2 = ...
GCKAdBreakClipInfo *breakClip3 = ...

GCKAdBreakInfo *break1 = [[GCKAdBreakInfoBuilder alloc] initWithAdBreakID:@"b0"
                                                           adBreakClipIds:@[@"bc0", @"bc1", @"bc2"]].build;

GCKMediaInformationBuilder *mediaInfoBuilder = [[GCKMediaInformationBuilder alloc]
                                                initWithEntity:@"entity"];
...
mediaInfoBuilder.adBreaks = @[break1];
mediaInfoBuilder.adBreakClips = @[breakClip1, breakClip2, breakClip3];
...
self.mediaInformation = [mediaInfoBuilder build];

GCKMediaLoadRequestDataBuilder *mediaLoadRequestDataBuilder = [[GCKMediaLoadRequestDataBuilder alloc] init];
mediaLoadRequestDataBuilder.mediaInformation = self.mediaInformation;

// Send a load request to the remote media client.
GCKRequest *request = [self.sessionManager.currentSession.remoteMediaClient
                                loadMediaWithLoadRequestData:[mediaLoadRequestDataBuilder build]];

再生速度の変更

アプリでは、現在のメディア アイテムの再生速度を表示し、変更できます。GCKRemoteMediaClient-[setPlaybackRate:] または -[setPlaybackRate:customData:] を使用してレートを設定し、GCKUIMediaControllerplaybackRateController を使用して GCKUIPlaybackRateController にアクセスし、GCKUIPlaybackRateControllerplaybackRate を使用して現在の再生レートを表示できます。

サンプルコード

次の 2 つのファイルは、「標準」、「半速度」、「倍速」ボタンがあるセグメント化されたコントロールを使用して再生レートを制御する GCKUIPlaybackRateController を実装しています。

Swift
import GoogleCast

/**
 * An implementation of GCKUIPlaybackRateController that controls playback rate
 * using a segmented control that has "normal", "half speed", and "double speed"
 * buttons.
 */
class SegmentedButtonPlaybackRateController: GCKUIPlaybackRateController {
  static let kSegmentNormal = 0;
  static let kSegmentHalfSpeed = 1;
  static let kSegmentDoubleSpeed = 2;

  var segmentedControl: UISegmentedControl!

  override var playbackRate: Float {
    didSet {
      var buttonIndex = 0

      // Map the playback rate to one of our three supported speeds.
      if playbackRate == 1.0 {
        buttonIndex = SegmentedButtonPlaybackRateController.kSegmentNormal
      } else if playbackRate < 1.0 {
        buttonIndex = SegmentedButtonPlaybackRateController.kSegmentHalfSpeed
      } else {
        buttonIndex = SegmentedButtonPlaybackRateController.kSegmentDoubleSpeed
      }

      segmentedControl?.selectedSegmentIndex = buttonIndex
    }
  }
  override var inputEnabled: Bool {
    didSet {
      segmentedControl?.isEnabled = inputEnabled
    }
  }

  /**
   * Designated initializer.
   *
   * @param segmentedControl The segmented control for changing/displaying the
   * playback rate.
   */
  convenience init(_ segmentedControl: UISegmentedControl) {
    self.init()
    self.segmentedControl = segmentedControl;

    segmentedControl.addTarget(self,
                               action: #selector(segmentedControlTapped(sender:)),
                               for: UIControl.Event.valueChanged)
  }

  @objc func segmentedControlTapped(sender: UISegmentedControl) {
    var playbackRate: Float = 1.0

    switch segmentedControl?.selectedSegmentIndex {
    case SegmentedButtonPlaybackRateController.kSegmentHalfSpeed:
      playbackRate = 0.5;
    case SegmentedButtonPlaybackRateController.kSegmentDoubleSpeed:
      playbackRate = 2.0;
    case SegmentedButtonPlaybackRateController.kSegmentNormal:
      fallthrough
    default:
      playbackRate = 1.0;
    }

    self.playbackRate = playbackRate
  }
}
Objective-C

SegmentedButtonPlaybackRateController.h

#import <GoogleCast/GoogleCast.h>
#import <UIKit/UIKit.h>

/**
 * An implementation of GCKUIPlaybackRateController that controls playback rate
 * using a segmented control that has "normal", "half speed", and "double speed"
 * buttons.
 */
@interface SegmentedButtonPlaybackRateController : GCKUIPlaybackRateController

/**
 * Designated initializer.
 *
 * @param segmentedControl The segmented control for changing/displaying the
 * playback rate.
 */
- (instancetype)initWithSegmentedControl:(UISegmentedControl *)segmentedControl;

@end

SegmentedButtonPlaybackRateController.m

#import "SegmentedButtonPlaybackRateController.h"

@interface SegmentedButtonPlaybackRateController () {
  UISegmentedControl *_segmentedControl;
}

@end

static const NSInteger kSegmentNormal = 0;
static const NSInteger kSegmentHalfSpeed = 1;
static const NSInteger kSegmentDoubleSpeed = 2;

@implementation SegmentedButtonPlaybackRateController

- (instancetype)initWithSegmentedControl:(UISegmentedControl *)segmentedControl {
  if (self = [super init]) {
    _segmentedControl = segmentedControl;
    [_segmentedControl addTarget:self
                          action:@selector(segmentedControlTapped:)
                forControlEvents:UIControlEventValueChanged];
  }
  return self;
}

- (void)setPlaybackRate:(float)playbackRate {
  [super setPlaybackRate:playbackRate];

  NSInteger buttonIndex = 0;

  // Map the playback rate to one of our three supported speeds.
  if (playbackRate == 1.0) {
    buttonIndex = kSegmentNormal;
  } else if (playbackRate < 1.0) {
    buttonIndex = kSegmentHalfSpeed;
  } else {
    buttonIndex = kSegmentDoubleSpeed;
  }

  _segmentedControl.selectedSegmentIndex = buttonIndex;
}

- (void)setInputEnabled:(BOOL)inputEnabled {
  _segmentedControl.enabled = inputEnabled;
  [super setInputEnabled:inputEnabled];
}

- (void)segmentedControlTapped:(id)sender {
  float playbackRate;

  switch (_segmentedControl.selectedSegmentIndex) {
    case kSegmentHalfSpeed:
      playbackRate = 0.5;
      break;

    case kSegmentDoubleSpeed:
      playbackRate = 2.0;
      break;

    case kSegmentNormal:
    default:
      playbackRate = 1.0;
      break;
  }

  self.playbackRate = playbackRate;
}

@end

カスタム チャネルを追加

キャスト フレームワークでは、ウェブ レシーバーにカスタム メッセージを送信するチャネルを作成する方法が 2 つあります。

  1. GCKCastChannel は、関連する状態を持つ重要なチャネルを実装するためにサブクラス化されることを意図しています。
  2. サブクラス化の代わりとして GCKGenericChannel が用意されています。受信したメッセージをデリゲートに渡して、他の場所で処理できるようにします。

GCKCastChannel の実装の例を次に示します。

Swift
class HGCTextChannel: GCKCastChannel {
  override func didReceiveTextMessage(_ message: String) {
    print("received message: \(message)")
  }
}
Objective-C

HGCTextChannel.h

#import <GoogleCast/GCKCastChannel.h>

@interface HGCTextChannel : GCKCastChannel

@end

HGCTextChannel.m

#import "HGCTextChannel.h"

@implementation HGCTextChannel
- (void)didReceiveTextMessage:(NSString*)message {
  NSLog(@"received message: %@", message);
}

@end

チャネルはいつでも登録できます。セッションが現在接続状態ではない場合、ウェブ レシーバー アプリのメタデータでサポートされている名前空間のリストにチャネルの名前空間が存在する場合、セッション自体が接続されたときにチャネルが自動的に接続されます。

各カスタム チャネルは一意の名前空間で定義され、接頭辞 urn:x-cast: で始まる必要があります(例: urn:x-cast:com.example.custom)。複数のカスタム チャネルを設定し、それぞれに一意の名前空間を指定することもできます。Web Receiver アプリは、同じ名前空間を使用してメッセージを送受信することもできます。

Swift
var error: GCKError?
let textChannel = HGCTextChannel.init(namespace: "urn:x-cast:com.google.cast.sample.helloworld")
sessionManager.currentCastSession?.add(textChannel)
textChannel.sendTextMessage("Hello World", error: &error)

if error != nil {
  print("Error sending text message \(error.debugDescription)")
}
Objective-C
NSError *error;
HGCTextChannel *textChannel = [[HGCTextChannel alloc] initWithNamespace:@"urn:x-cast:com.google.cast.sample.helloworld"];
[sessionManager.currentCastSession addChannel:textChannel];
[textChannel sendTextMessage:@"Hello World"
                       error:&error];

if (error != nil) {
  NSLog(@"Error sending text message: %@", error);
}

特定のチャネルが接続または切断されたときに実行する必要があるロジックを提供するには、GCKCastChannel を使用している場合は -[didConnect] メソッドと -[didDisconnect] メソッドをオーバーライドし、GCKGenericChannel を使用している場合は GCKGenericChannelDelegate-[castChannelDidConnect:] メソッドと -[castChannelDidDisconnect:] メソッドの実装を指定します。

自動再生のサポート

Autoplay API と Queueing API をご覧ください。

イメージの選択とキャッシュをオーバーライドする

フレームワークのさまざまなコンポーネント(キャスト ダイアログ、ミニ コントローラ、拡張コントローラ、GCKUIMediaController(設定されている場合))には、現在キャストされているメディアのアートワークが表示されます。通常、画像アートワークへの URL はメディアの GCKMediaMetadata に含まれますが、センダーアプリに URL の代替ソースがある場合があります。

GCKUIImagePicker プロトコルは、特定の用途と目的のサイズに適した画像を選択する手段を定義します。-[getImageWithHints:fromMetadata:] という単一のメソッドがあります。このメソッドは、パラメータとして GCKUIImageHints オブジェクトと GCKMediaMetadata オブジェクトを受け取り、結果として GCKImage オブジェクトを返します。フレームワークには、GCKMediaMetadata オブジェクトの画像リスト内の最初の画像が常に選択される GCKUIImagePicker のデフォルト実装が用意されていますが、GCKCastContext シングルトンの imagePicker プロパティを設定することで、別の実装を使用することもできます。

GCKUIImageCache プロトコルは、フレームワークによって HTTPS を使用してダウンロードされた画像をキャッシュに保存する手段も定義します。フレームワークには、ダウンロードした画像ファイルをアプリのキャッシュ ディレクトリに保存する GCKUIImageCache のデフォルト実装が用意されていますが、アプリは GCKCastContext シングルトンの imageCache プロパティを設定することで別の実装を提供できます。

次のステップ

これで、iOS Sender アプリに追加できる機能は終了です。これで、別のプラットフォーム(Android またはウェブ)用の送信者アプリや、ウェブ レシーバーを作成できます。