ZRC Broadcast Intent Interfaces for ZRC status

1. INTRODUCTION

Zoom Rooms have several partners provide speaker devices that can run ZRC, these devices build-in Android System. Sometimes the system wants to indicate Zoom Rooms status to change LED, wake up the screen and so on. Even some devices have no direct link to ZR, but with the network connection, this needs ZRC to send the ZR's IP address to them by Android broadcast.

This document intends to explain the broadcast interfaces that ZRC sent to the Android system. These interfaces are used for the partners' devices, to listen to the Zoom Rooms status changes.

2. INTERFACES

2.1 Pairing State

Pairing state indicates the connection state between ZRC and ZR, devices can link themselves to ZR when paired, and unlink when unpaired.

Intent Action

• ZRIntentDefinitions.ACTION_PAIR_STATE_CHANGED="us.zoom.zrc.action.PAIR_STATE_CHANGED"

Intent Extras

• "state" — the pairing state
  • 1 — for paired
  • 0 — for unpaired
• "ip_address" the IP address of ZR

Will send when

• ZRC launched, send state 0
• ZRC connected to ZR, send state 1
• ZRC disconnected to ZR, send state 0 when the user logged out, ZR exiting, network problems and so on, no matter what the reason is. More info This API used by Yealink CP960 and Poly Trio for audio over ethernet. The partners have a connector installed in the PC, the connecter can create a virtual audio device in PC once got the ip_address.

2.2 Incoming Call State

Indicate the incoming call state, this time ZR will play some ringtone.

Intent Action

• ZRIntentDefinitions.ACTION_INCOMING_CALL_STATE_CHANGED="us.zoom.zrc.action.INCOMING_CALL_STATE_CHANGED"

Intent Extras

• "state" — the incoming state, 1 has incoming calls, otherwise 0 (include decline or accepted by the user)

Will send when

• Receive a SIP call invite
• Receive a Zoom Meeting invite
• The user accepts or declines the incoming calls

More info This API used by Yealink P960 to flash LED when received an incoming invitation.

2.3 In-Call State

Indicate the in-call state (the in-call means SIP/PSTN call, local presentation, and meeting)

Intent Action

• ZRIntentDefinitions.ACTION_IN_CALL_STATE_CHANGED="us.zoom.zrc.action.IN_CALL_STATE_CHANGED"

Intent Extras

• "state" — the incoming state
  • 0 — idle
  • 1 — in the call
  • 2 — starting or joining a meeting

In-call when

• Make a PSTN call
• Make a SIP call
• Join or Make a Zoom Meeting
• Local Presentation for
• Desktop share with Zoom
• AirPlay Share for iPhone/iPad/Mac
• HDMI Share

More info This API used by Yealink P960 to prepare the audio before the meeting.

2.4 For Query

Send from 3rd party devices, when ZRC received this broadcast, ZRC will resend states with intents described before.

Intent Action

• ZRIntentDefinitions.ACTION_QUERY_ZOOM_INFO="us.zoom.zrc.action.QUERY_ZOOM_INFO"

Intent Extras

• "query_type" — Which interface needs ZRC to resend.
  • 0 — for All
  • 1 — for pairing state
  • 2 — for incoming call state
  • 3 — for in-call state

APPENDIX A - GLOSSARY

• ZR — Zoom Rooms
• ZRC — Zoom Rooms Controller