java.lang.Object

com.opentok.SipProperties.Builder

包含クラス: : SipProperties


public static class SipProperties.Builder extends 目的

このクラスを使用して、SipProperties オブジェクトを作成します。

関連項目: : - SipProperties

コンストラクタの概要

コンストラクタ

コンストラクタ

説明

Builder()

方法の概要

すべてのメソッド インスタンスメソッド 具体的なメソッド

修飾子と型

方法

説明

SipProperties

build()

SipProperties オブジェクトを作成します。

SipProperties.Builder

from(String from)

SIPを設定するには、このメソッドを呼び出してください from フィールド(任意)。

SipProperties.Builder

headersJsonStartingWithXDash(String headersJsonStartingWithXDash)

このメソッドを呼び出すことで、OpenTokからお客様のSIPプラットフォームに向けて送信されるSIP ​INVITE​に 追加されるカスタムヘッダーを定義できます。

SipProperties.Builder

observeForceMute(boolean observeForceMute)

このメソッドを呼び出し、以下を引数として渡します。 true SIPエンドポイントが以下を監視するようにする 強制ミュート.

SipProperties.Builder

password(String password)

SIPゲートウェイプロバイダのパスワードを設定するには、このメソッドを呼び出してください(オプション)。

SipProperties.Builder

secure(boolean secure)

このメソッドを呼び出し、以下を引数として渡します。 true メディアは 暗号化して送信しなければならないことを示すため。

SipProperties.Builder

sipUri(String sipUri)

SIP URI を設定するには、このメソッドを呼び出してください。

SipProperties.Builder

streams(String... streams)

SIP参加者がサブスクライブする参加者のストリームID。

SipProperties.Builder

userName(String userName)

SIPゲートウェイプロバイダのユーザー名を設定するには、このメソッドを呼び出してください(オプション)。

SipProperties.Builder

video(boolean video)

このメソッドを呼び出し、以下を引数として渡します。 true SIP通話でビデオ機能を有効にする。

java.lang クラスから継承されたメソッド。目的

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ビルダー

public Builder()

メソッドの詳細

sipUri

public SipProperties.Builder sipUri(ストリング sipUri)

SIP URI を設定するには、このメソッドを呼び出してください。

パラメータ: : sipUri - ​(必須) — OpenTokからお客様のSIPプラットフォームに向けて発信されるSIP通話の宛先として使用されるSIP URIです。SIP URIに​ transport=tls​ヘッダーが含まれている場合、OpenTokとSIPエンドポイント間のネゴシエーションは 安全に行われます。 なお、これはネゴシエーション自体にのみ適用され、 音声の伝送には適用されません。音声の伝送も暗号化したい場合は、 ​secure​ プロパティを ​true に設定する

戻り値: : SIP URI が設定された SipProperties.Builder オブジェクト。

より

public SipProperties.Builder from(ストリング (出典)

SIPを設定するには、このメソッドを呼び出してください from フィールド(任意)。

パラメータ: : from - 最終的なSIP番号に対して発信者として送信される番号または文字列。 以下の形式の文字列でなければなりません。 from@example.com, ここで from は文字列または 数値です。from が数値に設定されている場合(例えば、「14155550101@example.com)」の場合、 PSTN電話では発信元番号として表示されます。 「from」が未定義の場合、または文字列(例:「joe@example.com"), +00000000 が PSTN 電話の着信番号として表示されます。

戻り値: : 「from」番号が設定された SipProperties.Builder オブジェクト。

ユーザー名

public SipProperties.Builder userName(ストリング userName)

SIPゲートウェイプロバイダのユーザー名を設定するには、このメソッドを呼び出してください(オプション)。

パラメータ: : userName - ユーザー名。

戻り値: : ユーザー名が設定された SipProperties.Builder オブジェクト。

パスワード

public SipProperties.Builder パスワード(ストリング パスワード)

SIPゲートウェイプロバイダのパスワードを設定するには、このメソッドを呼び出してください(オプション)。

パラメータ: : password - パスワード。

戻り値: : パスワードが設定された SipProperties.Builder オブジェクト。

ヘッダーが「XDash」で始まるJSON

public SipProperties.Builder headersJsonStartingWithXDash(ストリング headersJsonStartingWithXDash)

このメソッドを呼び出すことで、OpenTokからお客様のSIPプラットフォームに向けて送信されるSIP ​INVITE​に 追加されるカスタムヘッダーを定義できます。

パラメータ: : headersJsonStartingWithXDash - このJSON文字列は、OpenTokからお客様のSIPプラットフォームに向けて送信されるSIP INVITEリクエストに追加されるカスタムヘッダーを定義します。

**Note:** You no longer need to append the ​"X-"​ prefix to the beginning of
custom headers. This restriction, which applied previously, has been removed.

戻り値: : SipProperties.Builder オブジェクト。

安全な

public SipProperties.Builder secure(boolean secure)

このメソッドを呼び出し、以下を引数として渡します。 true メディアは 暗号化して送信する必要があることを示すためです。以下を指定してください。 false​, 暗号化が 不要な場合のデフォルト設定です。

パラメータ: : secure - メディアを暗号化して送信する必要があるか (​true​)かどうかを示すブール値のフラグ(​false​がデフォルト)。

戻り値: : メディアのセキュリティ設定が設定された SipProperties.Builder オブジェクト。

ビデオ

public SipProperties.Builder video(boolean video)

このメソッドを呼び出し、以下を引数として渡します。 true SIP通話でビデオを有効にするには。 デフォルトは false.

パラメータ: : video - SIP通話でビデオ機能を有効にするかどうか。

戻り値: : SIP ビデオ設定が設定された SipProperties.Builder オブジェクト。

observeForceMute

public SipProperties.Builder observeForceMute(boolean observeForceMute)

このメソッドを呼び出し、以下を引数として渡します。 true SIPエンドポイントが以下を監視するようにする 強制ミュート. デフォルトは false.

パラメータ: : observeForceMute - 強制ミュートによるモデレーションを適用するかどうか。

戻り値: : `observeForceMute` 設定が適用された `SipProperties.Builder` オブジェクト。

ストリーム

public SipProperties.Builder ストリーム(ストリング... ストリーム)

SIP参加者がサブスクライブする参加者のストリームID。 指定がない場合は、セッション内のすべてのストリームが選択されます。

パラメータ: : streams - 選択するストリームID。

戻り値: : `streams` 設定が適用された `SipProperties.Builder` オブジェクト。

ビルド

public SipProperties build()

SipProperties オブジェクトを作成します。

戻り値: : SipProperties オブジェクト。