本文にスキップする
Version: 7.0

短いデータ送信

LINE Planetは、通信中に限られたサイズのデータ(「短いデータ」)をピアに送信できるAPIを提供します。このページでは、通話中に短いデータを送受信する方法について説明します。

対応する通話タイプ対応するSDKバージョン
1対1通話、グループ通話(カンファレンス)すべてのバージョン

共通事項

通話タイプに関係なく、短いデータの送信には以下の事項を適用します。

サイズの制限

短いデータを送信するメソッドは、データ自体と、データタイプを引数として受け取ります。データタイプおよびデータの最大サイズは次のとおりです。

  • データタイプ:100バイト(null終端文字を含む)
  • データ:800バイト

レート制限

1秒あたり1回の送信のみ許容されます。

短いデータの送信結果を得る

LINE Planetで何度も再試行した後もデータ送信に失敗する場合があります。結果ハンドラーコールバックを使用すると、非同期でデータ送信結果を確認できます。

1対1通話

1対1通話では、次のように短いデータを送受信できます。

短いデータを送信する

通話相手に短いデータを送信するには、PlanetKitCallsendShortData()を使用します。

func sendShortDataExample(call: PlanetKitCall, type: String, data: String) {
guard let byteData = data.data(using: .utf8) else {
print("Failed to convert string to data")
return
}

call.sendShortData(type: type, data: byteData) { reason in
guard reason == .none else {
print("sendShortData failed: \(reason)")
return
}
print("sendShortData succeeded: type=\(type), data=\(data)")
}
}

受信した短いデータを処理する

相手はPlanetKitCallDelegatedidReceiveShortDataを使用して短いデータを受信できます。

extension CallDelegateExample : PlanetKitCallDelegate {
...

func didReceiveShortData(_ call: PlanetKitCall, dataType: String, data: Data) {
// This is called when short data is received from the peer.
if let receivedData = String(data: data, encoding: .utf8) {
print("Received short data: type=\(dataType), data=\(receivedData)")
}
// Write your own code here to handle the received data.
}
}

グループ通話

グループ通話では、特定のピアまたはすべてのピアに短いデータを送信できます。

特定のピアに短いデータを送信する

特定のピアに短いデータを送信するには、PlanetKitConferencesendShortData(peerId:type:data:completion:)を使用します。

func sendShortDataToSpecificPeerExample(conference: PlanetKitConference, peerId: PlanetKitUserId, type: String, data: String) {
guard let byteData = data.data(using: .utf8) else {
print("Failed to convert string to data")
return
}

conference.sendShortData(peerId: peerId, type: type, data: byteData) { reason in
guard reason == .none else {
print("sendShortData failed: \(reason)")
return
}
print("sendShortData to \(peerId) succeeded: type=\(type), data=\(data)")
}
}

すべてのピアに短いデータを送信する

すべてのピアに短いデータを送信するには、PlanetKitConferencesendShortData(type:data:completion:)を使用します。

func sendShortDataToAllPeersExample(conference: PlanetKitConference, type: String, data: String) {
guard let byteData = data.data(using: .utf8) else {
print("Failed to convert string to data")
return
}

conference.sendShortData(type: type, data: byteData) { reason in
guard reason == .none else {
print("sendShortData failed: \(reason)")
return
}
print("sendShortData to all peers succeeded: type=\(type), data=\(data)")
}
}

受信した短いデータを処理する

ピアはPlanetKitConferenceDelegatedidReceiveShortDataを通じて短いデータを受信できます。

extension ConferenceDelegateExample : PlanetKitConferenceDelegate {
...

func didReceiveShortData(_ conference: PlanetKitConference, senderId: PlanetKitUserId, dataType: String, data: Data) {
// This is called when short data is received from a peer in the conference.
if let receivedData = String(data: data, encoding: .utf8) {
print("Received short data from \(senderId): type=\(dataType), data=\(receivedData)")
}
// Write your own code here to handle the received data.
}
}

短いデータ送信の失敗理由

結果ハンドラーのコールバックとして渡されるPlanetKitSendShortDataFailReason列挙型を通じて、短いデータ送信の結果と失敗理由を確認できます。考えられる失敗の理由は次のとおりです。

説明
none短いデータが正常に送信されました。
invalidParameter1つ以上の入力パラメーターが無効です(例:データサイズが0)。
tooLongDataTypeデータタイプが許容された最大長さを超えています(null終了文字を含めて100バイトを超過)。
tooLongDataデータペイロードが許容された最大サイズを超えています(800バイトを超過)。
tooFrequent短いデータが許容回数を超えて送信されました(レート制限を超過)。1秒あたり1回の送信のみ許容されます。
timeoutタイムアウトにより送信が失敗しました。
internalError内部エラーにより送信が失敗しました。

関連API

短いデータの送信に関連するAPIは、以下のとおりです。

共通

列挙型

1対1通話

メソッド

イベント

グループ通話

メソッド

イベント