stop()

stop()は、現在実行中のlocal detector runtimeだけを停止する関数です。

SDK access token、token refresh状態、アカウント/ポリシー状態は維持されます。そのため、同じユーザーが再度detectionを実行する必要がある場合、login()を再度呼び出さずにstart()を呼び出せます。

役割

stop()が呼び出されると、SDKは内部的に次のlocal runtime状態を整理します。

detection loopを停止
-> Webカメラstreamを停止
-> overlay状態を整理
-> local detection-event状態を整理

使用例

detector.stop();

ユーザーlogoutのようにSDK sessionまで終了する必要がある場合は、stop()後にlogout()を呼び出します。

detector.stop();
await detector.logout();

すでに停止している状態でstop()を再度呼び出すと、no-opとして処理されます。

logout()との違い

stop()はカメラと検知loopを止めるlocal runtime APIです。

logout()はSDK session終了APIです。detectorが実行中の場合、logout()はDETECTOR_RUNNINGエラーをthrowするため、先にstop()を呼び出す必要があります。

注意事項

• stop()はMonitorDog logout activity eventを送信しません。
• stop()はSDK access tokenを削除しません。
• 画面の一時離脱、タブ切り替え、一時停止のような流れにはstop()が適しています。
• ユーザーlogoutやsession終了の流れでは、stop()後にlogout()を呼び出してください。