WO2022241402A1 - Authorization management in a media playback system - Google Patents
Authorization management in a media playback system Download PDFInfo
- Publication number
- WO2022241402A1 WO2022241402A1 PCT/US2022/072211 US2022072211W WO2022241402A1 WO 2022241402 A1 WO2022241402 A1 WO 2022241402A1 US 2022072211 W US2022072211 W US 2022072211W WO 2022241402 A1 WO2022241402 A1 WO 2022241402A1
- Authority
- WO
- WIPO (PCT)
- Prior art keywords
- role
- playback
- token
- playback device
- permission
- Prior art date
Links
- 238000013475 authorization Methods 0.000 title abstract description 16
- 238000013507 mapping Methods 0.000 claims abstract description 205
- 238000000034 method Methods 0.000 claims abstract description 80
- 230000004044 response Effects 0.000 claims description 62
- 230000006870 function Effects 0.000 description 29
- 239000008186 active pharmaceutical agent Substances 0.000 description 24
- 238000010586 diagram Methods 0.000 description 24
- 238000012545 processing Methods 0.000 description 22
- 230000000694 effects Effects 0.000 description 16
- 238000005516 engineering process Methods 0.000 description 15
- 238000007726 management method Methods 0.000 description 15
- 230000008569 process Effects 0.000 description 12
- 230000009471 action Effects 0.000 description 11
- 230000008859 change Effects 0.000 description 9
- 238000001514 detection method Methods 0.000 description 9
- 238000013500 data storage Methods 0.000 description 8
- 238000010200 validation analysis Methods 0.000 description 6
- 238000004891 communication Methods 0.000 description 5
- 230000003993 interaction Effects 0.000 description 5
- 239000003607 modifier Substances 0.000 description 4
- 230000005236 sound signal Effects 0.000 description 4
- 230000008901 benefit Effects 0.000 description 3
- 230000005540 biological transmission Effects 0.000 description 3
- 239000000470 constituent Substances 0.000 description 3
- 235000019800 disodium phosphate Nutrition 0.000 description 3
- 230000001360 synchronised effect Effects 0.000 description 3
- 101000658638 Arabidopsis thaliana Protein TRANSPARENT TESTA 1 Proteins 0.000 description 2
- 239000000872 buffer Substances 0.000 description 2
- 238000005286 illumination Methods 0.000 description 2
- 238000004519 manufacturing process Methods 0.000 description 2
- 238000012986 modification Methods 0.000 description 2
- 230000004048 modification Effects 0.000 description 2
- 238000009877 rendering Methods 0.000 description 2
- 230000003595 spectral effect Effects 0.000 description 2
- 230000008685 targeting Effects 0.000 description 2
- TVEXGJYMHHTVKP-UHFFFAOYSA-N 6-oxabicyclo[3.2.1]oct-3-en-7-one Chemical compound C1C2C(=O)OC1C=CC2 TVEXGJYMHHTVKP-UHFFFAOYSA-N 0.000 description 1
- 230000003321 amplification Effects 0.000 description 1
- 230000001419 dependent effect Effects 0.000 description 1
- 238000011161 development Methods 0.000 description 1
- 230000007613 environmental effect Effects 0.000 description 1
- 238000001914 filtration Methods 0.000 description 1
- 230000002452 interceptive effect Effects 0.000 description 1
- 239000000543 intermediate Substances 0.000 description 1
- 230000007246 mechanism Effects 0.000 description 1
- 238000010295 mobile communication Methods 0.000 description 1
- 238000003032 molecular docking Methods 0.000 description 1
- 238000003199 nucleic acid amplification method Methods 0.000 description 1
- 230000002085 persistent effect Effects 0.000 description 1
- 238000007781 pre-processing Methods 0.000 description 1
- 238000000926 separation method Methods 0.000 description 1
- 239000000126 substance Substances 0.000 description 1
- 230000000007 visual effect Effects 0.000 description 1
Classifications
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04N—PICTORIAL COMMUNICATION, e.g. TELEVISION
- H04N21/00—Selective content distribution, e.g. interactive television or video on demand [VOD]
- H04N21/40—Client devices specifically adapted for the reception of or interaction with content, e.g. set-top-box [STB]; Operations thereof
- H04N21/43—Processing of content or additional data, e.g. demultiplexing additional data from a digital video stream; Elementary client operations, e.g. monitoring of home network or synchronising decoder's clock; Client middleware
- H04N21/436—Interfacing a local distribution network, e.g. communicating with another STB or one or more peripheral devices inside the home
- H04N21/43615—Interfacing a Home Network, e.g. for connecting the client to a plurality of peripherals
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F21/00—Security arrangements for protecting computers, components thereof, programs or data against unauthorised activity
- G06F21/30—Authentication, i.e. establishing the identity or authorisation of security principals
- G06F21/31—User authentication
- G06F21/33—User authentication using certificates
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F21/00—Security arrangements for protecting computers, components thereof, programs or data against unauthorised activity
- G06F21/30—Authentication, i.e. establishing the identity or authorisation of security principals
- G06F21/44—Program or device authentication
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F21/00—Security arrangements for protecting computers, components thereof, programs or data against unauthorised activity
- G06F21/60—Protecting data
- G06F21/62—Protecting access to data via a platform, e.g. using keys or access control rules
- G06F21/629—Protecting access to data via a platform, e.g. using keys or access control rules to features or functions of an application
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F3/00—Input arrangements for transferring data to be processed into a form capable of being handled by the computer; Output arrangements for transferring data from processing unit to output unit, e.g. interface arrangements
- G06F3/16—Sound input; Sound output
- G06F3/165—Management of the audio stream, e.g. setting of volume, audio stream path
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04L—TRANSMISSION OF DIGITAL INFORMATION, e.g. TELEGRAPHIC COMMUNICATION
- H04L63/00—Network architectures or network communication protocols for network security
- H04L63/10—Network architectures or network communication protocols for network security for controlling access to devices or network resources
- H04L63/102—Entity profiles
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04L—TRANSMISSION OF DIGITAL INFORMATION, e.g. TELEGRAPHIC COMMUNICATION
- H04L63/00—Network architectures or network communication protocols for network security
- H04L63/10—Network architectures or network communication protocols for network security for controlling access to devices or network resources
- H04L63/105—Multiple levels of security
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04N—PICTORIAL COMMUNICATION, e.g. TELEVISION
- H04N21/00—Selective content distribution, e.g. interactive television or video on demand [VOD]
- H04N21/20—Servers specifically adapted for the distribution of content, e.g. VOD servers; Operations thereof
- H04N21/25—Management operations performed by the server for facilitating the content distribution or administrating data related to end-users or client devices, e.g. end-user or client device authentication, learning user preferences for recommending movies
- H04N21/258—Client or end-user data management, e.g. managing client capabilities, user preferences or demographics, processing of multiple end-users preferences to derive collaborative data
- H04N21/25808—Management of client data
- H04N21/25816—Management of client data involving client authentication
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04N—PICTORIAL COMMUNICATION, e.g. TELEVISION
- H04N21/00—Selective content distribution, e.g. interactive television or video on demand [VOD]
- H04N21/20—Servers specifically adapted for the distribution of content, e.g. VOD servers; Operations thereof
- H04N21/25—Management operations performed by the server for facilitating the content distribution or administrating data related to end-users or client devices, e.g. end-user or client device authentication, learning user preferences for recommending movies
- H04N21/258—Client or end-user data management, e.g. managing client capabilities, user preferences or demographics, processing of multiple end-users preferences to derive collaborative data
- H04N21/25866—Management of end-user data
- H04N21/25875—Management of end-user data involving end-user authentication
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04N—PICTORIAL COMMUNICATION, e.g. TELEVISION
- H04N21/00—Selective content distribution, e.g. interactive television or video on demand [VOD]
- H04N21/40—Client devices specifically adapted for the reception of or interaction with content, e.g. set-top-box [STB]; Operations thereof
- H04N21/41—Structure of client; Structure of client peripherals
- H04N21/4104—Peripherals receiving signals from specially adapted client devices
- H04N21/4126—The peripheral being portable, e.g. PDAs or mobile phones
- H04N21/41265—The peripheral being portable, e.g. PDAs or mobile phones having a remote control device for bidirectional communication between the remote control device and client device
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04N—PICTORIAL COMMUNICATION, e.g. TELEVISION
- H04N21/00—Selective content distribution, e.g. interactive television or video on demand [VOD]
- H04N21/40—Client devices specifically adapted for the reception of or interaction with content, e.g. set-top-box [STB]; Operations thereof
- H04N21/41—Structure of client; Structure of client peripherals
- H04N21/422—Input-only peripherals, i.e. input devices connected to specially adapted client devices, e.g. global positioning system [GPS]
- H04N21/4227—Providing Remote input by a user located remotely from the client device, e.g. at work
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04N—PICTORIAL COMMUNICATION, e.g. TELEVISION
- H04N21/00—Selective content distribution, e.g. interactive television or video on demand [VOD]
- H04N21/80—Generation or processing of content or additional data by content creator independently of the distribution process; Content per se
- H04N21/81—Monomedia components thereof
- H04N21/8106—Monomedia components thereof involving special audio data, e.g. different tracks for different languages
- H04N21/8113—Monomedia components thereof involving special audio data, e.g. different tracks for different languages comprising music, e.g. song in MP3 format
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F21/00—Security arrangements for protecting computers, components thereof, programs or data against unauthorised activity
- G06F21/60—Protecting data
- G06F21/604—Tools and structures for managing or administering access control systems
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F2221/00—Indexing scheme relating to security arrangements for protecting computers, components thereof, programs or data against unauthorised activity
- G06F2221/21—Indexing scheme relating to G06F21/00 and subgroups addressing additional information or applications relating to security arrangements for protecting computers, components thereof, programs or data against unauthorised activity
- G06F2221/2141—Access rights, e.g. capability lists, access control lists, access tables, access matrices
Definitions
- the present technology relates to consumer goods and, more particularly, to methods, systems, products, features, services, and other elements directed to voice-assisted control of media playback systems or some aspect thereof.
- Media content e.g., songs, podcasts, video sound
- playback devices such that each room with a playback device can play back corresponding different media content.
- rooms can be grouped together for synchronous playback of the same media content, and/or the same media content can be heard in all rooms synchronously.
- Figure 1A is a partial cutaway view of an environment having a media playback system configured in accordance with aspects of the disclosed technology.
- Figure IB is a schematic diagram of the media playback system of Figure 1A and one or more networks.
- Figure 2A is a functional block diagram of an example playback device.
- Figure 2B is an isometric diagram of an example housing of the playback device of
- Figure 2C is a diagram of an example voice input.
- Figure 2D is a graph depicting an example sound specimen in accordance with aspects of the disclosure.
- Figures 3A, 3B, 3C, 3D and 3E are diagrams showing example playback device configurations in accordance with aspects of the disclosure.
- FIG. 4 is a functional block diagram of an example controller device in accordance with aspects of the disclosure.
- Figures 5A and 5B are controller interfaces in accordance with aspects of the disclosure.
- Figure 6 is a message flow diagram of a media playback system.
- Figure 7 is functional block diagrams illustrating an example authorization management architecture in accordance with aspects of the disclosed technology.
- Figures 8A, 8B, and 8C are example message flow diagrams illustrating example authorization management in accordance with aspects of the disclosed technology.
- Figures 9A, 9B, and 9C are functional block diagrams illustrating example authorization management in accordance with aspects of the disclosed technology.
- Figure 10 is a flow diagram of an example method to process command intermediates in accordance with aspects of the disclosed technology.
- a media playback system may include one or more playback devices, which may take the form of "smart" speakers having integrated processors, memory, operating systems, and applications configured to perform audio playback and related functions.
- Such audio playback and other functions of the playback device(s) are controllable using a controller, such as a control application installed on another computing device (e.g., a mobile device or laptop) via network messaging (e.g., via a local area network).
- a client e.g., a controller
- a client e.g., a controller
- restricted data e.g., state information
- Example authorization management may involve authenticating a client.
- Example clients include controllers, which may be first-party (e.g., a controller application developed by the manufacturer of the media playback system to provide control functionality) and third-party (e.g., applications developed by various content services, such as streaming audio services, that support one or more application programming interfaces (API)s to enable control of the playback devices within the media playback system.
- An client may send authentication credentials (e.g., a user name/password, a pin, scanned token, client SSL certificate, among other examples) to a first authentication service (e.g., AuthN) executing on a computing system (e.g., a cloud computing system).
- a token e.g., an OAuth token
- the client may then authenticate with the playback devices using the token. For instance, when performing a restricted action on a playback device, the client may send the token to the playback device.
- Example control protocols or APIs may utilize HTTP requests and responses.
- the token may be transmitted using HTTP headers.
- the token authenticates the client (i.e., this client is who they say they are), but might not be configured with any additional information about the client's "role.”
- a subject e.g., the client
- the media playback system (and all constituent playback devices in the household) are the object.
- the client may have a certain role with respect to all of the playback devices in the system.
- the media playback system may be divided into two or more objects (e.g., based on rooms or zones configured within the media playback system).
- a client may have different roles in different zones (or may have the same role in all zones).
- the playback device may resolve a role for the client.
- a second authentication service e.g., AuthZ
- a computing system e.g., on a cloud computing system
- the playback device may maintain an edge data cache in data storage on the playback device that includes token-to-role mappings. After a successful query to the second authentication service, the playback device may store a received token-to-role mapping in the edge data cache. Then, when receiving the token again, the playback device may check the edge data cache first and, if the token-to-role mapping is in the edge data cache (i.e., a cache hit), the playback device may resolve the role using this mapping rather than querying the second authentication service. If the token-to-role mapping is not found in the edge data cache (i.e., a cache miss, perhaps because the mapping had expired or the mapping had not yet been queried), the playback device can query to second authentication service.
- authorization management may further involve resolving permissions for the role.
- the second authentication service e.g., AuthZ
- the playback device may send the role to the second authentication service, which may return a set of permissions for that token.
- This role-to- permission mapping may be cached in the edge data cache, and used for subsequent permissions resolutions. Generally, by caching such data in an edge data cache and resolving roles and permissions at the edge, requests to the cloud may be reduced, which may ultimately reduce data transmission costs.
- Example roles include owner and guest.
- an owner role may have full permissions on their media playback system while a guest may have reduced roles. Since roles operate on subjects (e.g., media playback systems), a given client may have one role (e.g., owner) on their own media playback system and a different role (e.g., guest) on other media playback systems (e.g., a media playback system belonging to their friend).
- subjects e.g., media playback systems
- a given client may have one role (e.g., owner) on their own media playback system and a different role (e.g., guest) on other media playback systems (e.g., a media playback system belonging to their friend).
- the set of permissions may be in the form of a permissions mask with different integers in the mask represent permissions for different types of commands, similar to a Unix permissions mask.
- read permissions are represented using the T integer while read and modify permissions are represented using the '3' integer.
- a guest role may have a 133 mask with the first digit corresponding to a "groups" namespace (representing permission to read but not modify groups), the second digit corresponding to a "playback" namespace (representing permission to read current playback status and modify the state), and the third digit corresponding to a "volume” namespace (representing permission to read current volume status and modify it).
- a subj ect-to-role mapping may have a relatively short time-to-live in the edge data cache.
- a role-to-permissions map is less likely to change frequently and may apply to a larger set of clients.
- a cached role-to-permissions map may have a relatively longer time-to-live and may be able to avoid a relatively higher number of requests to the second authentication service.
- the playback device may apply permissions. For instance, the playback device may determine whether the received playback command is permitted by the permissions for that client. For instance, following the example above, if the permission mask is 133 and the command is to change volume level, the playback device may determine based on the '3' digit in the volumes namespace that this client has permissions to change the volume. The playback device may then carry out the command.
- example techniques relate to authentication management in a media playback system.
- An example implementation involves a system comprising a first playback
- the first playback device comprises, a network interface, at least one processor and data storage including instructions that are executable by the at least one processor such that the first playback device is configured to: receive, via the network interface, first data representing (i) a first playback command and (ii) a first token corresponding to a first client, wherein the first client and the playback device are connected to a local area network; determine that an edge data cache excludes a token-to-role mapping corresponding to the first token; send, via the network interface to the computing system, a request for a role corresponding to the first token, wherein the computing system is outside of the local area network; receive, via the network interface, a response to the request indicating a first token-to-role mapping that maps the first token to a first role; when the edge data cache excludes the token-to-role mapping corresponding to the first token, cache, in the edge data cache for a first time-to-live period, the first token-to-role mapping that maps the first token to
- FIGS 1A and IB illustrate an example configuration of a media playback system 100 (or “MPS 100”) in which one or more embodiments disclosed herein may be implemented.
- the MPS 100 as shown is associated with an example home environment having a plurality of rooms and spaces, which may be collectively referred to as a
- the environment 101 comprises a household having several rooms, spaces, and/or playback zones, including a master bathroom 101a, a master bedroom 101b, (referred to herein as “Nick’s Room”), a second bedroom 101c, a family room or den lOld, an office lOle, a living room lOlf, a dining room lOlg, a kitchen lOlh, and an outdoor patio lOli. While certain embodiments and examples are described below in the context of a home environment, the technologies described herein may be implemented in other types of environments.
- the MPS 100 can be implemented in one or more commercial settings (e.g., a restaurant, mall, airport, hotel, a retail or other store), one or more vehicles (e.g., a sports utility vehicle, bus, car, a ship, a boat, an airplane), multiple environments (e.g., a combination of home and vehicle environments), and/or another suitable environment where multi-zone audio may be desirable.
- a commercial setting e.g., a restaurant, mall, airport, hotel, a retail or other store
- vehicles e.g., a sports utility vehicle, bus, car, a ship, a boat, an airplane
- multiple environments e.g., a combination of home and vehicle environments
- multi-zone audio may be desirable.
- the MPS 100 includes one or more computing devices.
- such computing devices can include playback devices 102 (identified individually as playback devices 102a-102n), network microphone devices 103 (identified individually as “NMDs” 103a-102i), and controller devices 104a and 104b (collectively “controller devices 104”).
- the home environment may include additional and/or other computing devices, including local network devices, such as one or more smart illumination devices 108 ( Figure IB), a smart thermostat 110, and a local computing device 105 ( Figure 1A).
- the various playback, network microphone, and controller devices 102, 103, and 104 and/or other network devices ofthe MPS 100 may be coupled to one another via point-to-point connections and/or over other connections, which may be wired and/or wireless, via a network 111, such as a LAN including a network router 109.
- a network 111 such as a LAN including a network router 109.
- the playback device 102j in the Den 101 d ( Figure 1A), which may be designated as the “Left” device, may have a point-to-point connection with the playback device 102a, which is also in the Den lOld and may be designated as the “Right” device.
- the Left playback device 102j may communicate with other network devices, such as the playback device 102b, which may be designated as the “Front” device, via a point-to-point connection and/or other connections via the NETWORK 111.
- the MPS 100 may be coupled to one or more remote computing devices 106 via a wide area network (“WAN”) (i.e., the Internet), labeled here as the networks 107.
- WAN wide area network
- each remote computing device 106 may take the form of
- the remote computing devices 106 may be configured to interact with computing devices in the environment 101 in various ways.
- the remote computing devices 106 may be configured to facilitate streaming and/or controlling playback of media content, such as audio, in the home environment 101.
- the various playback devices, NMDs, and/or controller devices 102-104 may be communicatively coupled to at least one remote computing device associated with a VAS and at least one remote computing device associated with a media content service (“MCS”).
- remote computing devices 106 are associated with a VAS 190 and remote computing devices 106b are associated with an MCS 192.
- MCS media content service
- the MPS 100 may be coupled to multiple, different VASes and/or MCSes.
- VASes may be operated by one or more of AMAZON, GOOGLE, APPLE, MICROSOFT, SONOS or other voice assistant providers.
- MCSes may be operated by one or more of SPOTIFY, PANDORA, AMAZON MUSIC, or other media content services.
- Media content services are also referred to herein as streaming audio services.
- the remote computing devices 106 further include remote computing device 106c configured to perform certain operations, such as remotely facilitating media playback functions, managing device and system status information, directing communications between the devices of the MPS 100 and one or multiple VASes and/or MCSes, among other operations.
- the remote computing devices 106c provide cloud servers for one or more SONOS Wireless HiFi Systems.
- one or more of the playback devices 102 may take the form of or include an on-board (e.g., integrated) network microphone device.
- the playback devices 102a-e include or are otherwise equipped with corresponding NMDs 103a-e, respectively.
- a playback device that includes or is equipped with an NMD may be referred to herein interchangeably as a playback device or an NMD unless indicated otherwise in the description.
- one or more of the NMDs 103 may be a stand-alone device.
- the NMDs 103f and 103g may be stand-alone devices.
- a stand-alone NMD may omit components and/or functionality that is typically included in a playback device, such as a speaker or related electronics. For instance, in such cases, a stand-alone NMD may not produce audio output or may produce limited audio output (e.g., relatively low-quality audio output).
- the various playback and network microphone devices 102 and 103 of the MPS 100 may each be associated with a unique name, which may be assigned to the respective devices by a user, such as during setup of one or more of these devices. For instance, as shown in the illustrated example of Figure IB, a user may assign the name “Bookcase” to playback device 102d because it is physically situated on a bookcase. Similarly, the NMD 103f may be assigned the named “Island” because it is physically situated on an island countertop in the kitchen lOlh ( Figure 1A).
- Some playback devices may be assigned names according to a zone or room, such as the playback devices 102e, 1021, 102m, and 102n, which are named “Bedroom,” “Dining Room,” “Living Room,” and “Office,” respectively. Further, certain playback devices may have functionally descriptive names. For example, the playback devices 102a and 102b are assigned the names “Right” and “Front,” respectively, because these two devices are configured to provide specific audio channels during media playback in the zone of the Den 101 d ( Figure 1A). The playback device 102c in the Patio may be named portable because it is battery-powered and/or readily transportable to different areas of the environment 101. Other naming conventions are possible.
- an NMD may detect and process sound from its environment, such as sound that includes background noise mixed with speech spoken by a person in the NMD’s vicinity. For example, as sounds are detected by the NMD in the environment, the NMD may process the detected sound to determine if the sound includes speech that contains voice input intended for the NMD and ultimately a particular VAS. For example, the NMD may identify whether speech includes a wake word associated with a particular VAS.
- the NMDs 103 are configured to interact with the VAS 190 over a network via the network 111 and the router 109. Interactions with the VAS 190 may be initiated, for example, when an NMD identifies in the detected sound a potential wake word. The identification causes a wake-word event, which in turn causes the NMD to begin transmitting detected-sound data to the VAS 190.
- the various local network devices 102-105 ( Figure 1A) and/or remote computing devices 106c of the MPS 100 may exchange various feedback, information, instructions, and/or related data with the remote computing devices associated with the selected VAS. Such exchanges may be related to or independent of transmitted messages containing voice inputs.
- the remote computing device(s) and the MPS 100 may exchange data via communication paths as described herein and/or using a metadata exchange channel as described in U.S. Application No. 15/438,749
- the VAS 190 determines if there is voice input in the streamed data from the NMD, and if so the VAS 190 will also determine an underlying intent in the voice input.
- the VAS 190 may next transmit a response back to the MPS 100, which can include transmitting the response directly to the NMD that caused the wake-word event.
- the response is typically based on the intent that the VAS 190 determined was present in the voice input.
- the VAS 190 may determine that the underlying intent of the voice input is to initiate playback and further determine that intent of the voice input is to play the particular song “Hey Jude.” After these determinations, the VAS 190 may transmit a command to a particular MCS 192 to retrieve content (i.e., the song “Hey Jude”), and that MCS 192, in turn, provides (e.g., streams) this content directly to the MPS 100 or indirectly via the VAS 190. In some implementations, the VAS 190 may transmit to the MPS 100 a command that causes the MPS 100 itself to retrieve the content from the MCS 192.
- NMDs may facilitate arbitration amongst one another when voice input is identified in speech detected by two or more NMDs located within proximity of one another.
- the NMD-equipped playback device 102d in the environment 101 ( Figure 1A) is in relatively close proximity to the NMD-equipped Living Room playback device 102m, and both devices 102d and 102m may at least sometimes detect the same sound. In such cases, this may require arbitration as to which device is ultimately responsible for providing detected-sound data to the remote VAS. Examples of arbitrating between NMDs may be found, for example, in previously referenced U.S. Application No. 15/438,749.
- an NMD may be assigned to, or otherwise associated with, a designated or default playback device that may not include an NMD.
- the Island NMD 103f in the kitchen lOlh ( Figure 1A) may be assigned to the dining room playback device 1021, which is in relatively close proximity to the Island NMD 103f.
- an NMD may direct an assigned playback device to play audio in response to a remote VAS receiving a voice input from the NMD to play the audio, which the NMD might have sent to the VAS in response to a user speaking a command to play a certain song, album, playlist, etc. Additional details regarding assigning NMDs and playback devices as designated or default devices may be found, for example, in previously referenced U.S. Patent Application No.
- the NETWORK 111 ( Figure IB) may be eliminated and the single playback device 102 and/or the single NMD 103 may communicate directly with the remote computing devices 106-d.
- a telecommunication network e.g., an LTE network, a 5G network, etc.
- FIG. 2A is a functional block diagram illustrating certain aspects of one of the playback devices 102 of the MPS 100 of Figures 1A and IB.
- the playback device 102 includes various components, each of which is discussed in further detail below, and the various components of the playback device 102 may be operably coupled to one another via a system bus, communication network, or some other connection mechanism.
- the playback device 102 may be referred to as an “NMD-equipped” playback device because it includes components that support the functionality of an NMD, such as one of the NMDs 103 shown in Figure 1A.
- the playback device 102 includes at least one processor 212, which may be a clock-driven computing component configured to process input data according to instructions stored in memory 213.
- the memory 213 may be a tangible, non-transitory, computer-readable medium configured to store instructions that are executable by the processor 212.
- the memory 213 may be data storage that can be loaded with software code 214 that is executable by the processor 212 to achieve certain functions.
- these functions may involve the playback device 102 retrieving audio data from an audio source, which may be another playback device.
- the functions may involve the playback device 102 sending audio data, detected-sound data (e.g., corresponding to a voice input), and/or other information to another device on a network via at
- the functions may involve the playback device 102 causing one or more other playback devices to synchronously playback audio with the playback device 102.
- the functions may involve the playback device 102 facilitating being paired or otherwise bonded with one or more other playback devices to create a multi-channel audio environment. Numerous other example functions are possible, some of which are discussed below.
- certain functions may involve the playback device 102 synchronizing playback of audio content with one or more other playback devices.
- a listener may not perceive time-delay differences between playback of the audio content by the synchronized playback devices.
- the playback device 102 includes audio processing components 216 that are generally configured to process audio prior to the playback device 102 rendering the audio.
- the audio processing components 216 may include one or more digital-to-analog converters (“DAC”), one or more audio preprocessing components, one or more audio enhancement components, one or more digital signal processors (“DSPs”), and so on.
- DAC digital-to-analog converters
- DSPs digital signal processors
- one or more of the audio processing components 216 may be a subcomponent of the processor 212.
- the audio processing components 216 receive analog and/or digital audio and process and/or otherwise intentionally alter the audio to produce audio signals for playback.
- the produced audio signals may then be provided to one or more audio amplifiers 217 for amplification and playback through one or more speakers 218 operably coupled to the amplifiers 217.
- the audio amplifiers 217 may include components configured to amplify audio signals to a level for driving one or more of the speakers 218.
- the software code 214 configures the playback device 102 to be operable in a plurality of non contemporary room sound modes. In each mode, the playback device 102 may adopt certain settings and/or configurations in accordance with the room sound mode. Further, the software code 214 may be configured to detect occurrence of various triggers corresponding to one of more of the room sounds, and responsively switch the first playback
- Each of the speakers 218 may include an individual transducer (e.g., a “driver”) or the speakers 218 may include a complete speaker system involving an enclosure with one or more drivers.
- a particular driver of a speaker 218 may include, for example, a subwoofer (e.g., for low frequencies), a mid-range driver (e.g., for middle frequencies), and/or a tweeter (e.g., for high frequencies).
- a transducer may be driven by an individual corresponding audio amplifier of the audio amplifiers 217.
- a playback device may not include the speakers 218, but instead may include a speaker interface for connecting the playback device to external speakers.
- a playback device may include neither the speakers 218 nor the audio amplifiers 217, but instead may include an audio interface (not shown) for connecting the playback device to an external audio amplifier or audio-visual receiver.
- the audio processing components 216 may be configured to process audio to be sent to one or more other playback devices, via the network interface 224, for playback.
- audio content to be processed and/or played back by the playback device 102 may be received from an external source, such as via an audio line-in interface (e.g., an auto-detecting 3.5mm audio line- in connection) of the playback device 102 (not shown) or via the network interface 224, as described below.
- an audio line-in interface e.g., an auto-detecting 3.5mm audio line- in connection
- the at least one network interface 224 may take the form of one or more wireless interfaces 225 and/or one or more wired interfaces 226.
- a wireless interface may provide network interface functions for the playback device 102 to wirelessly communicate with other devices (e.g., other playback device(s), NMD(s), and/or controller device(s)) in accordance with a communication protocol (e.g., any wireless standard including IEEE 802.11a, 802.1 lb, 802.1 lg, 802.11h, 802.1 lac, 802.15, 4G mobile communication standard, and so on).
- a communication protocol e.g., any wireless standard including IEEE 802.11a, 802.1 lb, 802.1 lg, 802.11h, 802.1 lac, 802.15, 4G mobile communication standard, and so on.
- a wired interface may provide network interface functions for the playback device 102 to communicate over a wired connection with other devices in accordance with a communication protocol (e.g., IEEE 802.3). While the network interface 224 shown in Figure 2 A include both wired and wireless interfaces, the playback device 102 may in some implementations include only wireless interface(s) or only wired interface(s).
- a communication protocol e.g., IEEE 802.3
- the network interface 224 facilitates data flow between the playback device 102 and one or more other devices on a data network.
- the playback device 102 For instance, the playback device
- the audio content and other signals transmitted and received by the playback device 102 may be transmitted in the form of digital packet data comprising an Internet Protocol (IP)-based source address and IP-based destination addresses.
- IP Internet Protocol
- the network interface 224 may be configured to parse the digital packet data such that the data destined for the playback device 102 is properly received and processed by the playback device 102.
- the playback device 102 also includes voice processing components 220 that are operably coupled to one or more microphones 222.
- the microphones 222 are configured to detect sound (i.e., acoustic waves) in the environment of the playback device 102, which is then provided to the voice processing components 220. More specifically, each microphone 222 is configured to detect sound and convert the sound into a digital or analog signal representative of the detected sound, which can then cause the voice processing component 220 to perform various functions based on the detected sound, as described in greater detail below.
- the microphones 222 are arranged as an array of microphones (e.g., an array of six microphones).
- the playback device 102 includes more than six microphones (e.g., eight microphones or twelve microphones) or fewer than six microphones (e.g., four microphones, two microphones, or a single microphones).
- the voice-processing components 220 are generally configured to detect and process sound received via the microphones 222, identify potential voice input in the detected sound, and extract detected-sound data to enable a VAS, such as the VAS 190 ( Figure IB), to process voice input identified in the detected-sound data.
- a VAS such as the VAS 190 ( Figure IB)
- the voice processing components 220 may include one or more analog-to-digital converters, an acoustic echo canceller (“AEC”), a spatial processor (e.g., one or more multi-channel Wiener filters, one or more other filters, and/or one or more beam former components), one or more buffers (e.g., one or more circular buffers), one or more wake-word engines, one or more voice extractors, and/or one or more speech processing components (e.g., components configured to recognize a voice of a particular user or a particular set of users associated with a household), among other example voice processing components.
- the voice processing components 220 may include or otherwise take the form of one or more DSPs or one or more modules of a DSP.
- certain voice processing components 220 may be configured with particular parameters (e.g., gain and/or spectral parameters) that may be modified or otherwise tuned to achieve particular
- one or more of the voice processing components 220 may be a subcomponent of the processor 212.
- the playback device 102 also includes power components 227.
- the power components 227 include at least an external power source interface 228, which may be coupled to a power source (not shown) via a power cable or the like that physically connects the playback device 102 to an electrical outlet or some other external power source.
- Other power components may include, for example, transformers, converters, and like components configured to format electrical power.
- the power components 227 of the playback device 102 may additionally include an internal power source 229 (e.g., one or more batteries) configured to power the playback device 102 without a physical connection to an external power source.
- an internal power source 229 e.g., one or more batteries
- the playback device 102 may operate independent of an external power source.
- the external power source interface 228 may be configured to facilitate charging the internal power source 229.
- a playback device comprising an internal power source may be referred to herein as a “portable playback device.”
- a playback device that operates using an external power source may be referred to herein as a “stationary playback device,” although such a device may in fact be moved around a home or other environment.
- the playback device 102 further includes a user interface 240 that may facilitate user interactions independent of or in conjunction with user interactions facilitated by one or more of the controller devices 104.
- the user interface 240 includes one or more physical buttons and/or supports graphical interfaces provided on touch sensitive screen(s) and/or surface(s), among other possibilities, for a user to directly provide input.
- the user interface 240 may further include one or more of lights (e.g., LEDs) and the speakers to provide visual and/or audio feedback to a user.
- Figure 2B shows an example housing 230 of the playback device 102 that includes a user interface in the form of a control area 232 at a top portion 234 of the housing 230.
- the control area 232 includes buttons 236a-c for controlling audio playback, volume level, and other functions.
- the control area 232 also includes a button 236d for toggling the microphones 222 to either an on state or an off state.
- control area 232 is at least partially surrounded by apertures formed in the top portion 234 of the housing 230 through which the microphones 222
- the microphones 222 may be arranged in various positions along and/or within the top portion 234 or other areas of the housing 230 so as to detect sound from one or more directions relative to the playback device 102.
- SONOS, Inc. presently offers (or has offered) for sale certain playback devices that may implement certain of the embodiments disclosed herein, including a “PLAY:1,” “PLAY: 3,” “PLAY:5,” “PLAYBAR,” “CONNECT: AMP,” “PLAYBASE,” “BEAM,” “CONNECT,” and “SUB.” Any other past, present, and/or future playback devices may additionally or alternatively be used to implement the playback devices of example embodiments disclosed herein. Additionally, it should be understood that a playback device is not limited to the examples illustrated in Figures 2A or 2B or to the SONOS product offerings.
- a playback device may include, or otherwise take the form of, a wired or wireless headphone set, which may operate as a part of the MPS 100 via a network interface or the like.
- a playback device may include or interact with a docking station for personal mobile media playback devices.
- a playback device may be integral to another device or component such as a television, a lighting fixture, or some other device for indoor or outdoor use.
- FIG. 2C is a diagram of an example voice input 280 that may be processed by an NMD or an NMD-equipped playback device.
- the voice input 280 may include a keyword portion 280a and an utterance portion 280b.
- the keyword portion 280a may include a wake word or a command keyword.
- the keyword portion 280a corresponds to detected sound that caused a wake-word
- the utterance portion 280b corresponds to detected sound that potentially comprises a user request following the keyword portion 280a.
- An utterance portion 280b can be processed to identify the presence of any words in detected-sound data by the NMD in response to the event caused by the keyword portion 280a.
- an underlying intent can be determined based on the words in the utterance portion 280b. In certain implementations, an underlying intent can also be based or at least partially based on certain words in the keyword portion 280a, such as when keyword portion includes a command keyword. In any case, the words may correspond to one or more commands, as well as a certain command and certain keywords.
- a keyword in the voice utterance portion 280b may be, for example, a word identifying a particular device or group in the MPS 100.
- the keywords in the voice utterance portion 280b may be one or more words identifying one or more zones in which the music is to be played, such as the Living Room and the Dining Room ( Figure 1A).
- the utterance portion 280b may include additional information, such
- pauses e.g., periods of non-speech
- the pauses may demarcate the locations of separate commands, keywords, or other information spoke by the user within the utterance portion 280b.
- command criteria may be based on the inclusion of certain keywords within the voice input, among other possibilities. Additionally, or alternatively, command criteria for commands may involve identification of one or more control-state and/or zone-state variables in conjunction with identification of one or more particular commands.
- Control-state variables may include, for example, indicators identifying a level of volume, a queue associated with one or more devices, and playback state, such as whether devices are playing a queue, paused, etc.
- Zone-state variables may include, for example, indicators identifying which, if any, zone players are grouped.
- the MPS 100 is configured to temporarily reduce the volume of audio content that it is playing upon detecting a certain keyword, such as a wake word, in the keyword portion 280a.
- the MPS 100 may restore the volume after processing the voice input 280.
- Such a process can be referred to as ducking, examples of which are disclosed in U.S. Patent Application No. 15/438,749, incorporated by reference herein in its entirety.
- Figure 2D shows an example sound specimen.
- the sound specimen corresponds to the sound-data stream (e.g., one or more audio frames) associated with a spotted wake word or command keyword in the keyword portion 280a of Figure 2A.
- the example sound specimen comprises sound detected in an NMD’s environment (i) immediately before a wake or command word was spoken, which may be referred to as a pre-roll portion (between times to and ti), (ii) while a wake or command word was spoken, which may be referred to as a wake-meter portion (between times ti and t2), and/or (iii) after the wake or command word was spoken, which may be referred to as a post-roll portion (between times t2 and t3).
- a pre-roll portion between times to and ti
- a wake-meter portion between times ti and t2
- a post-roll portion between times t2 and t3
- aspects of the sound specimen can be evaluated according to an acoustic model which aims to map mels/spectral features to phonemes in a given language model for further processing.
- ASR automatic speech recognition
- Wake-word detection engines may be precisely tuned to identify a specific wake-word, and a downstream action of invoking a VAS (e.g., by targeting only nonce words in the voice input processed by the playback device).
- ASR for command keyword detection may be tuned to accommodate a wide range of keywords (e.g., 5, 10, 100, 1,000, 10,000 keywords).
- Command keyword detection in contrast to wake-word detection, may involve feeding ASR output to an onboard, local NLU which together with the ASR determine when command word events have occurred.
- the local NLU may determine an intent based on one or more other keywords in the ASR output produced by a particular voice input.
- a playback device may act on a detected command keyword event only when the playback devices determines that certain conditions have been met, such as environmental conditions (e.g., low background noise).
- the playback device 102 may further include a voice activity detector (VAD), which may be implemented as part of the voice processing components 220.
- VAD voice activity detector
- the VAD is configured to detect the presence (or lack thereol) of voice activity in the sound-data stream from the microphones 222.
- the VAD may analyze frames corresponding to the pre-roll portion of the voice input 280a ( Figure 2D) with one or more voice detection algorithms to determine whether voice activity was present in the environment in certain time windows prior to a keyword portion of the voice input 280a.
- the VAD may utilize any suitable voice activity detection algorithms.
- Example voice detection algorithms involve determining whether a given frame includes one or more features or qualities that correspond to voice activity, and further determining whether those features or qualities diverge from noise to a given extent (e.g., if a value exceeds a threshold for a given frame).
- Some example voice detection algorithms involve filtering or otherwise reducing noise in the frames prior to identifying the features or qualities.
- the VAD may determine whether voice activity is present in the environment based on one or more metrics. For example, the VAD can be configured to distinguish between frames that include voice activity and frames that don't include voice activity. The frames that the VAD determines have voice activity may be caused by speech regardless of whether it near- or far-field. In this example and others, the VAD may determine a count of frames in the voice input 280a that indicate voice activity. If this count exceeds a threshold percentage or number of frames, the VAD may be configured to output a signal or set a state variable indicating that voice activity is present in the environment. Other metrics may be used as well in addition to, or as an alternative to, such a count.
- the VAD When the VAD detects voice activity in an environment, the VAD may set a state variable in the playback device indicating that voice activity is present. Conversely, when the VAD does not voice activity in an environment, the VAD may set the state variable in the playback device to indicate that voice activity is not present. Changing the state of this state variable may function as a mode trigger condition in some examples. b. Example Playback Device Configurations
- Figures 3A-3E show example configurations of playback devices.
- a single playback device may belong to a zone.
- the playback device 102c ( Figure 1A) on the Patio may belong to Zone A.
- multiple playback devices may be “bonded” to form a “bonded pair,” which together form a single zone.
- the playback device 102f ( Figure 1A) named “Bed 1” in Figure 3 A may be bonded to the playback device 102g ( Figure 1 A) named “Bed 2” in Figure 3A to form Zone B. Bonded playback devices may have different playback responsibilities (e.g., channel responsibilities).
- multiple playback devices may be merged to form a single zone.
- the playback device 102d named “Bookcase” may be merged with the playback device 102m named “Living Room” to form a single Zone C.
- the merged playback devices 102d and 102m may not be specifically assigned different playback responsibilities. That is, the merged playback devices 102d and 102m may, aside from playing audio content in synchrony, each play audio content as they would if they were not merged.
- each zone in the MPS 100 may be represented as a single user interface (“UI”) entity.
- UI user interface
- Zone A may be provided as a single entity named “Portable”
- Zone B may be provided as a single entity named “Stereo”
- Zone C may be provided as a single entity named “Living Room.”
- a zone may take on the name of one of the playback devices belonging to the zone.
- Zone C may take on the name of the Living Room device 102m (as shown).
- Zone C may instead take on the name of the Bookcase device 102d.
- Zone C may take on a name that is some combination of the Bookcase device 102d and Living Room device 102m. The name that is chosen may be selected by a user via inputs at a controller device 104.
- a zone may be given a name that is different than the device(s) belonging to the zone.
- Zone B in Figure 3 A is named “Stereo” but none of the devices in Zone B have this name.
- Zone B is a
- the Bed 1 device may be playback device 102f in the master bedroom 101b ( Figure 1 A) and the Bed 2 device may be the playback device 102g also in the master bedroom 101b ( Figure 1 A).
- playback devices that are bonded may have different playback responsibilities, such as playback responsibilities for certain audio channels.
- the Bed 1 and Bed 2 devices 102f and 102g may be bonded so as to produce or enhance a stereo effect of audio content.
- the Bed 1 playback device 102f may be configured to play a left channel audio component
- the Bed 2 playback device 102g may be configured to play a right channel audio component.
- stereo bonding may be referred to as “pairing.”
- playback devices that are configured to be bonded may have additional and/or different respective speaker drivers.
- the playback device 102b named “Front” may be bonded with the playback device 102k named “SUB.”
- the Front device 102b may render a range of mid to high frequencies, and the SUB device 102k may render low frequencies as, for example, a subwoofer. When unbonded, the Front device 102b may be configured to render a full range of frequencies.
- Figure 3D shows the Front and SUB devices 102b and 102k further bonded with Right and Left playback devices 102a and 102j, respectively.
- the Right and Left devices 102a and 102j may form surround or “satellite” channels of a home theater system.
- the bonded playback devices 102a, 102b, 102j, and 102k may form a single Zone D ( Figure 3A).
- playback devices may also be “merged.”
- playback devices that are merged may not have assigned playback responsibilities, but may each render the full range of audio content that each respective playback device is capable of.
- merged devices may be represented as a single UI entity (i.e., a zone, as discussed above).
- Figure 3E shows the playback devices 102d and 102m in the Living Room merged, which would result in these devices being represented by the single UI entity of Zone C.
- the playback devices 102d and 102m may playback audio in synchrony, during which each outputs the full range of audio content that each respective playback device 102d and 102m is capable of rendering.
- a stand-alone NMD may be in a zone by itself.
- the NMD 103h from Figure 1A is named “Closet” and forms Zone I in Figure 3A.
- An NMD may
- Zone F which is also named “Kitchen.” Additional details regarding assigning NMDs and playback devices as designated or default devices may be found, for example, in previously referenced U.S. Patent Application No. 15/438,749. In some embodiments, a stand-alone NMD may not be assigned to a zone.
- Zones of individual, bonded, and/or merged devices may be arranged to form a set of playback devices that playback audio in synchrony. Such a set of playback devices may be referred to as a “group,” “zone group,” “synchrony group,” or “playback group.”
- playback devices may be dynamically grouped and ungrouped to form new or different groups that synchronously play back audio content.
- Zone A may be grouped with Zone B to form a zone group that includes the playback devices of the two zones.
- Zone A may be grouped with one or more other Zones C-I.
- the Zones A-I may be grouped and ungrouped in numerous ways.
- Zones A-I may be grouped.
- the zones of individual and/or bonded playback devices may play back audio in synchrony with one another, as described in previously referenced U.S. Patent No. 8,234,395.
- Grouped and bonded devices are example types of associations between portable and stationary playback devices that may be caused in response to a trigger event, as discussed above and described in greater detail below.
- the zones in an environment may be assigned a particular name, which may be the default name of a zone within a zone group or a combination of the names of the zones within a zone group, such as “Dining Room + Kitchen,” as shown in Figure 3A.
- a zone group may be given a unique name selected by a user, such as “Nick’s Room,” as also shown in Figure 3A.
- the name “Nick’s Room” may be a name chosen by a user over a prior name for the zone group, such as the room name “Master Bedroom.”
- certain data may be stored in the memory 213 as one or more state variables that are periodically updated and used to describe the state of a playback zone, the playback device(s), and/or a zone group associated therewith.
- the memory 213 may also include the data associated with the state of the other devices of the MPS 100, which may be shared from time to time among the devices so that one or more of the devices have the most recent data associated with the system.
- the memory 213 of the playback device 102 may store instances of various variable types associated with the states. Variables instances may be stored with identifiers (e.g., tags) corresponding to type. For example, certain identifiers may be a first type “al” to identify playback device(s) of a zone, a second type “bl” to identify playback device(s) that may be bonded in the zone, and a third type “cl” to identify a zone group to which the zone may belong. As a related example, in Figure 1A, identifiers associated with the Patio may indicate that the Patio is the only playback device of a particular zone and not in a zone group.
- identifiers associated with the Patio may indicate that the Patio is the only playback device of a particular zone and not in a zone group.
- Identifiers associated with the Living Room may indicate that the Living Room is not grouped with other zones but includes bonded playback devices 102a, 102b, 102j, and 102k.
- Identifiers associated with the Dining Room may indicate that the Dining Room is part of Dining Room + Kitchen group and that devices 103f and 102i are bonded.
- Identifiers associated with the Kitchen may indicate the same or similar information by virtue of the Kitchen being part of the Dining Room + Kitchen zone group. Other example zone variables and identifiers are described below.
- the MPS 100 may include variables or identifiers representing other associations of zones and zone groups, such as identifiers associated with Areas, as shown in Figure 3A.
- An Area may involve a cluster of zone groups and/or zones not within a zone group.
- Figure 3A shows a first area named “First Area” and a second area named “Second Area.”
- the First Area includes zones and zone groups of the Patio, Den, Dining Room, Kitchen, and Bathroom.
- the Second Area includes zones and zone groups of the Bathroom, Nick’s Room, Bedroom, and Living Room.
- an Area may be used to invoke a cluster of zone groups and/or zones that share one or more zones and/or zone groups of another cluster.
- Such an Area differs from a zone group, which does not share a zone with another zone group.
- Further examples of techniques for implementing Areas may be found, for example, in U.S. Application No. 15/682,506 filed August 21, 2017 and titled “Room Association Based on Name,” and U.S. Patent No. 8,483,853 filed September 11, 2007, and titled “Controlling and manipulating groupings in a multi -zone media system.” Each of these applications is incorporated herein by reference in its entirety.
- the memory 213 may be further configured to store other data. Such data may pertain to audio sources accessible by the playback device 102 or a playback queue that the playback device (or some other playback device(s)) may be associated with. In embodiments described below, the memory 213 is configured to store a set of command data for selecting a particular VAS when processing voice inputs. During operation, one or more playback zones in the environment of Figure 1A may each be playing different audio content. For instance, the user
- a playback zone may play the same audio content in synchrony with another playback zone.
- the user may be in the Office zone where the playback device 102n is playing the same hip-hop music that is being playing by playback device 102c in the Patio zone.
- playback devices 102c and 102n may be playing the hip-hop in synchrony such that the user may seamlessly (or at least substantially seamlessly) enjoy the audio content that is being played out-loud while moving between different playback zones. Synchronization among playback zones may be achieved in a manner similar to that of synchronization among playback devices, as described in previously referenced U.S. Patent No. 8,234,395.
- the zone configurations of the MPS 100 may be dynamically modified.
- the MPS 100 may support numerous configurations. For example, if a user physically moves one or more playback devices to or from a zone, the MPS 100 may be reconfigured to accommodate the change(s). For instance, if the user physically moves the playback device 102c from the Patio zone to the Office zone, the Office zone may now include both the playback devices 102c and 102n. In some cases, the user may pair or group the moved playback device 102c with the Office zone and/or rename the players in the Office zone using, for example, one of the controller devices 104 and/or voice input. As another example, if one or more playback devices 102 are moved to a particular space in the home environment that is not already a playback zone, the moved playback device(s) may be renamed or associated with a playback zone for the particular space.
- different playback zones of the MPS 100 may be dynamically combined into zone groups or split up into individual playback zones.
- the Dining Room zone and the Kitchen zone may be combined into a zone group for a dinner party such that playback devices 102i and 1021 may render audio content in synchrony.
- bonded playback devices in the Den zone may be split into (i) a television zone and (ii) a separate listening zone.
- the television zone may include the Front playback device 102b.
- the listening zone may include the Right, Left, and SUB playback devices 102a, 102j, and 102k, which may be grouped, paired, or merged, as described above.
- Splitting the Den zone in such a manner may allow one user to listen to music in the listening zone in one area of the living room space, and another user to watch the television in another area of the living room space.
- a user may utilize
- the listening zone may be controlled, for example, by a user in the vicinity of the NMD 103a
- the television zone may be controlled, for example, by a user in the vicinity of the NMD 103b.
- any of the NMDs 103 may be configured to control the various playback and other devices of the MPS 100.
- FIG 4 is a functional block diagram illustrating certain aspects of a selected one of the controller devices 104 of the MPS 100 of Figure 1A.
- controller devices may also be referred to herein as a “control device” or “controller.”
- the controller device shown in Figure 4 may include components that are generally similar to certain components of the network devices described above, such as a processor 412, memory 413 storing program software 414, at least one network interface 424, and one or more microphones 422.
- a controller device may be a dedicated controller for the MPS 100.
- a controller device may be a network device on which media playback system controller application software may be installed, such as for example, an iPhoneTM, iPadTM or any other smart phone, tablet, or network device (e.g., a networked computer such as a PC or MacTM).
- network device e.g., a networked computer such as a PC or MacTM.
- the memory 413 of the controller device 104 may be configured to store controller application software and other data associated with the MPS 100 and/or a user of the system 100.
- the memory 413 may be loaded with instructions in software 414 that are executable by the processor 412 to achieve certain functions, such as facilitating user access, control, and/or configuration of the MPS 100.
- the controller device 104 is configured to communicate with other network devices via the network interface 424, which may take the form of a wireless interface, as described above.
- system information may be communicated between the controller device 104 and other devices via the network interface 424.
- the controller device 104 may receive playback zone and zone group configurations in the MPS 100 from a playback device, an NMD, or another network device.
- the controller device 104 may transmit such system information to a playback device or another network device via the network interface 424.
- the other network device may be another controller device.
- the controller device 104 may also communicate playback device control commands, such as volume control and audio playback control, to a playback device via the
- changes to configurations of the MPS 100 may also be performed by a user using the controller device 104.
- the configuration changes may include adding/removing one or more playback devices to/from a zone, adding/removing one or more zones to/from a zone group, forming a bonded or merged player, separating one or more playback devices from a bonded or merged player, among others.
- the controller device 104 also includes a user interface 440 that is generally configured to facilitate user access and control of the MPS 100.
- the user interface 440 may include a touch-screen display or other physical interface configured to provide various graphical controller interfaces, such as the controller interfaces 540a and 540b shown in Figures 5A and 5B.
- the controller interfaces 540a and 540b includes a playback control region 542, a playback zone region 543, a playback status region 544, a playback queue region 546, and a sources region 548.
- the user interface as shown is just one example of an interface that may be provided on a network device, such as the controller device shown in Figure 4, and accessed by users to control a media playback system, such as the MPS 100.
- a network device such as the controller device shown in Figure 4
- Other user interfaces of varying formats, styles, and interactive sequences may alternatively be implemented on one or more network devices to provide comparable control access to a media playback system.
- the playback control region 542 may include selectable icons (e.g., by way of touch or by using a cursor) that, when selected, cause playback devices in a selected playback zone or zone group to play or pause, fast forward, rewind, skip to next, skip to previous, enter/exit shuffle mode, enter/exit repeat mode, enter/exit cross fade mode, etc.
- the playback control region 542 may also include selectable icons that, when selected, modify equalization settings and/or playback volume, among other possibilities.
- the playback zone region 543 may include representations of playback zones within the MPS 100.
- the playback zones regions 543 may also include a representation of zone groups, such as the Dining Room + Kitchen zone group, as shown.
- the graphical representations of playback zones may be selectable to bring up additional selectable icons to manage or configure the playback zones in the MPS 100, such as a creation of bonded zones, creation of zone groups, separation of zone groups, and renaming of zone groups, among other possibilities.
- a “group” icon may be provided within each of the graphical representations of playback zones.
- the “group” icon provided within a graphical representation of a particular zone may be selectable to bring up options to select one or more other zones in the MPS 100 to be grouped with the particular zone.
- playback devices in the zones that have been grouped with the particular zone will be configured to play audio content in synchrony with the playback device(s) in the particular zone.
- a “group” icon may be provided within a graphical representation of a zone group. In this case, the “group” icon may be selectable to bring up options to deselect one or more zones in the zone group to be removed from the zone group.
- Other interactions and implementations for grouping and ungrouping zones via a user interface are also possible.
- the representations of playback zones in the playback zone region 543 ( Figure 5B) may be dynamically updated as playback zone or zone group configurations are modified.
- the playback status region 544 may include graphical representations of audio content that is presently being played, previously played, or scheduled to play next in the selected playback zone or zone group.
- the selected playback zone or zone group may be visually distinguished on a controller interface, such as within the playback zone region 543 and/or the playback status region 544.
- the graphical representations may include track title, artist name, album name, album year, track length, and/or other relevant information that may be useful for the user to know when controlling the MPS 100 via a controller interface.
- the playback queue region 546 may include graphical representations of audio content in a playback queue associated with the selected playback zone or zone group.
- each playback zone or zone group may be associated with a playback queue comprising information corresponding to zero or more audio items for playback by the playback zone or zone group.
- each audio item in the playback queue may comprise a uniform resource identifier (URI), a uniform resource locator (URL), or some other identifier that may be used by a playback device in the playback zone or zone group to find and/or retrieve the audio item from a local audio content source or a networked audio content source, which may then be played back by the playback device.
- URI uniform resource identifier
- URL uniform resource locator
- a playlist may be added to a playback queue, in which case information corresponding to each audio item in the playlist may be added to the playback queue.
- audio items in a playback queue may be saved as a playlist.
- a playback queue may be empty, or populated but “not in use” when the playback zone
- a playback queue can include Internet radio and/or other streaming audio content items and be “in use” when the playback zone or zone group is playing those items. Other examples are also possible.
- playback queues associated with the affected playback zones or zone groups may be cleared or re associated. For example, if a first playback zone including a first playback queue is grouped with a second playback zone including a second playback queue, the established zone group may have an associated playback queue that is initially empty, that contains audio items from the first playback queue (such as if the second playback zone was added to the first playback zone), that contains audio items from the second playback queue (such as if the first playback zone was added to the second playback zone), or a combination of audio items from both the first and second playback queues.
- the resulting first playback zone may be re-associated with the previous first playback queue or may be associated with a new playback queue that is empty or contains audio items from the playback queue associated with the established zone group before the established zone group was ungrouped.
- the resulting second playback zone may be re-associated with the previous second playback queue or may be associated with a new playback queue that is empty or contains audio items from the playback queue associated with the established zone group before the established zone group was ungrouped.
- Other examples are also possible.
- the graphical representations of audio content in the playback queue region 646 may include track titles, artist names, track lengths, and/or other relevant information associated with the audio content in the playback queue.
- graphical representations of audio content may be selectable to bring up additional selectable icons to manage and/or manipulate the playback queue and/or audio content represented in the playback queue. For instance, a represented audio content may be removed from the playback queue, moved to a different position within the playback queue, or selected to be played immediately, or after any currently playing audio content, among other possibilities.
- a playback queue associated with a playback zone or zone group may be stored in a memory on one or more playback devices in the playback zone or zone group, on a playback device that is not in the playback zone or zone group, and/or some other designated device. Playback of such a playback
- 27 queue may involve one or more playback devices playing back media items of the queue, perhaps in sequential or random order.
- the sources region 548 may include graphical representations of selectable audio content sources and/or selectable voice assistants associated with a corresponding VAS.
- the VASes may be selectively assigned.
- multiple VASes such as AMAZON’S Alexa, MICROSOFT’S Cortana, etc., may be invokable by the same NMD.
- a user may assign a VAS exclusively to one or more NMDs. For example, a user may assign a first VAS to one or both of the NMDs 102a and 102b in the Living Room shown in Figure 1A, and a second VAS to the NMD 103f in the Kitchen. Other examples are possible.
- Example Audio Content Sources are possible.
- the audio sources in the sources region 548 may be audio content sources from which audio content may be retrieved and played by the selected playback zone or zone group.
- One or more playback devices in a zone or zone group may be configured to retrieve for playback audio content (e.g., according to a corresponding URI or URL for the audio content) from a variety of available audio content sources.
- audio content may be retrieved by a playback device directly from a corresponding audio content source (e.g., via a line-in connection).
- audio content may be provided to a playback device over a network via one or more other playback devices or network devices.
- audio content may be provided by one or more media content services.
- Example audio content sources may include a memory of one or more playback devices in a media playback system such as the MPS 100 of Figure 1, local music libraries on one or more network devices (e.g., a controller device, a network-enabled personal computer, or a networked-attached storage (“NAS”)), streaming audio services providing audio content via the Internet (e.g., cloud-based music services), or audio sources connected to the media playback system via a line-in input connection on a playback device or network device, among other possibilities.
- network devices e.g., a controller device, a network-enabled personal computer, or a networked-attached storage (“NAS”)
- streaming audio services providing audio content via the Internet (e.g., cloud-based music services)
- audio content sources may be added or removed from a media playback system such as the MPS 100 of Figure 1A.
- an indexing of audio items may be performed whenever one or more audio content sources are added, removed, or updated. Indexing of audio items may involve scanning for identifiable audio items in all folders/directories shared over a network accessible by playback devices in the media playback system and generating or updating an audio content database comprising metadata (e.g., title, artist, album,
- FIG. 6 is a message flow diagram illustrating data exchanges between devices of the MPS 100.
- the MPS 100 receives an indication of selected media content (e.g., one or more songs, albums, playlists, podcasts, videos, stations) via the control device 104.
- the selected media content can comprise, for example, media items stored locally on or more devices (e.g., the audio source 105 of Figure 1C) connected to the media playback system and/or media items stored on one or more media service servers (one or more of the remote computing devices 106 of Figure IB).
- the control device 104 transmits a message 651a to the playback device 102 ( Figures 1A-1C) to add the selected media content to a playback queue on the playback device 102.
- the playback device 102 receives the message 651a and adds the selected media content to the playback queue for play back.
- the control device 104 receives input corresponding to a command to play back the selected media content.
- the control device 104 transmits a message 651b to the playback device 102 causing the playback device 102 to play back the selected media content.
- the playback device 102 transmits a message 651c to the computing device 106 requesting the selected media content.
- the computing device 106 in response to receiving the message 651c, transmits a message 651d comprising data (e.g., audio data, video data, a URL, a URI) corresponding to the requested media content.
- the playback device 102 receives the message 651d with the data corresponding to the requested media content and plays back the associated media content.
- the playback device 102 optionally causes one or more other devices to play back the selected media content.
- the playback device 102 is one of a bonded zone of two or more players ( Figure 1M).
- the playback device 102 can receive the selected media content and transmit all or a portion of the media content to other devices in the bonded zone.
- the playback device 102 is a coordinator of a group and is configured to transmit and receive timing information from one or more other devices in the group.
- the other one or more devices in the group can receive the selected media content from the computing device 106, and begin playback of the selected media content in response to a message
- such messages may conform to one or more protocols or interfaces (e.g., an Application Programming Interface).
- a platform API may support one or more namespaces that include controllable resources (e.g., the playback devices 102 and features thereof).
- Various functions may modify the resources and thereby control actions on the playback devices 102.
- HTTP request methods such as GET and POST may request and modify various resources in a namespace.
- Example namespaces in a platform API include playback (including controllable resources for playback), playbackMetadata (including metadata resources related to playback), volume (including resources for volume control), playlist (including resources for queue management), and groupVolume (including resources for volume control of a synchrony group), among other examples.
- such messages may conform to a standard, such as universal-plug-and-play (uPnP).
- FIG. 7 is a functional block diagram illustrating an example architecture 700 to facilitate authorization management.
- the architecture 700 and its constituent devices is provided for purposes of illustration only, and other implementations may include different combinations of devices.
- the platform servers 706 may provide one or more platform services that support the media playback system 100.
- the one or more platform servers 706 may operate as a cloud-based hub for a plurality of media playback systems 100 (e.g., with unique household identifiers, which may be registered to different users and/or located in different households), as well as other types of “smart home” systems and platforms.
- the platform servers 706 may be self-hosted, or hosted using a cloud service provider (e.g., Amazon Web Services®), or may be representative of third-party computing systems that provide cloud services.
- a cloud service provider e.g., Amazon Web Services®
- the platform servers 706 are located in the "cloud.” That is, they are not on the LAN 111 and are instead connected to the networks 107 ( Figure IB).
- Other computing systems in the cloud include the computing devices 106a (which provide the voice assistant service 190) ( Figure IB) and also the computing devices 106b (which provide the MCS 192).
- the platform servers 706 may provide a first authentication service 706a (illustrated as an AuthN service 706a) and a second authentication service 706b (represented as an AuthZ service 706b).
- the AuthN service 706a is an identify authentication service that is configured to receive user credentials (e.g., a user name/password, a pin, scanned token, client SSL certificate, among other examples) from a client and, if such user credentials are valid, provide an authorization token (e.g., an OAuth token) in response.
- the AuthZ service 706b is a service that provides information on the role and permissions that a client with a particular identity (i.e., the token) should be allowed to access.
- FIG. 7 also shows examples of clients.
- a control device 104a is representative of an example of the control device 104 implemented using a mobile device and a media playback system control application (e.g., a first party control application).
- a control device 104b is representative of an example of the control device 104 implemented using a mobile device and a streaming audio service application (e.g., a third party streaming audio service application, such as a SPOTIFY ®, PANDORA®, or APPLE MUSIC® app).
- a third possible client is an NMD 103f.
- Each of these example clients are configurable to control at least some features on the playback devices 102a-n ( Figure 1A).
- Figure 7 shows the playback device 102n as including an edge data cache 760.
- certain authorization data such as token-to-role mappings 761a and/or role-to-permissions mappings 761b, may be cached to reduce interaction with the cloud. That is, instead of querying the platform services 706, certain queries may be handled by data stored in the edge data cache 760.
- certain hosting related costs may be reduced. For instance, some third party hosting services may charge by the number of I/O requests made and a lower number of requests will result in lower hosting costs.
- the edge data cache 760 may be stored in a portion of the memory 213. Yet further, in some examples, the edge data cache 760 may be maintain in random access memory (RAM) to avoid write cycles on persistent flash data storage. Since the playback devices 102 are seldom powered-off (instead entering a low-power state when not in use), the cache can be maintained in RAM for sufficiently long periods.
- RAM random access memory
- FIG. 8A is a message flow diagram illustrating data exchanges between devices shown the architecture 700 to perform authorization of anew client (the control device 104a).
- the message flow diagram begins with authenticating a client.
- the control device 104a sends
- the authentication service 706a determines whether the authentication credentials are valid, and if so, sends a token to the control device 104a at 865b. This token is referred to in this example as a first token.
- Example commands include various commands that direct the playback device to perform any of the example features described herein, as well as other features of playback devices.
- the commands may take the form of HTTP request methods such as GET and POST, which reference a resource in a namespace to get information about the resource or to set certain values of the resource. For instance, a POST request in a playback namespace may set a media item to play back.
- the client Before performing a restricted action (e.g., via the command), the client authenticates with the playback device 102n.
- the command includes the first token.
- the first token may be referenced in a header (e.g., an HTTP header) possibly along with other information to facilitate the command. This token may be used to authenticate the client with the playback device 102n.
- the playback device 102n After receiving such a command, the playback device 102n attempts to resolve the role(s). In particular, at 865d, the playback device 102n checks a token-to-role cache. For instance, the playback device 102n may determine whether the edge data cache 760 includes or excludes a token-to-role mapping corresponding to the first token (e.g., in the token-to-role mappings 761a) ( Figure 7). Based on determining that the edge data cache 760 excludes a token-to-role mapping corresponding to the first token (i.e., a cache miss), the playback device 102n goes to the cloud to attempt to resolve the roles.
- a token-to-role mapping corresponding to the first token i.e., a cache miss
- the playback device 102n sends a request for a role corresponding to the first token to the authentication service 706b.
- the request includes indications of the first token, the object (e.g., the media playback system 100, or the playback device 102n, depending on scope), and any modifiers.
- the request may take the form of a HTTP POST request with the indications carried in a header.
- An example POST request to resolve roles is shown as follows:
- attributes can be expanded “route”: “lan”, // lan
- the HTTP header of the POST request includes an OAuth token, an objectID (indicating the serial number of the playback device 102n), an obj ectType (including that it’s a player, or playback device), as well as some attributes. As discussed in further detail below, such attributes may modify the permissions granted to a role.
- the authentication service 706b sends a request to validate the first token to the authentication service 706a. Then, at 865g, the authentication service 706a replies with a validation result. If the first token is valid, the validation result indicates that the first token is valid and also provides an indication of a first time-to-live period (denoted as "TTL1"). This first time- to-live period indicates how long the authentication token remains valid. After a time-to-live period expires, the associated cached data is considered stale and cannot be used to resolve roles.
- TTL1 first time-to-live period
- the authentication service 706b determines the token-to-role mapping for the first token.
- the authentication service 706b maintains or has access to token-to-role mappings for each token.
- the authentication service 706b may act as a "source of truth" for such mappings in the authentication system.
- mappings may be created via a client having certain permissions (e.g., administrator or owner permissions) using a suitable user interface (e.g., the user interface 440 in Figure 4) in order to assign certain users and/or their respective client devices to specific roles within the media playback system 100.
- a suitable user interface e.g., the user interface 440 in Figure 4
- some clients may be unknown or anonymous such that there is no mapping for that client.
- the clients may be automatically assigned to a specific role (e.g., guest). Such clients may be latter elevated to a different role via the user interface.
- determining the token-to-role mapping for the first token may involve querying a database or other data storage structure for a role matching the object and the token. Such a query may return an indication of the role(s) corresponding to the token on the
- An indication of such roles may be ultimately provided to the playback device 102n in a response.
- the role(s) may be modified based on one or more modifiers.
- a modifier is the route of the client command.
- example values of the route modifier include LAN, WAN, and Bluetooth. Commands arriving via the LAN and/or Bluetooth routes may be modified to a relatively higher role, as connection via such routes is generally more trustworthy than a WAN route (e.g., from a guest to an owner role). That is, a client on a secure LAN or a Bluetooth connection is more likely to be a trusted client than a client attempting to connect via the broader internet.
- all three routes may modify the role differently. For instance, a LAN route may modify the role to a higher role, the Bluetooth route might not modify the role, and the WAN route may lower the role. Many examples of different modifications based on the routes are contemplated.
- the authentication service 706b sends a response to the playback device 102n. If the first token is valid, the response will indicate a success.
- An example successful response is shown as follows:
- the HTTP header also includes a policyKey which indicates the role(s) corresponding to the first token. This role is referred to herein as a first role.
- the HTTP header of the response also includes information to facilitate caching.
- the header indicates the first time-to-live period, which in this example is 300 seconds.
- the header also includes an entity tag (“ETag”) to identify the particular version of the resource (e.g., the policyKey). As explained in further detail below, the ETag may be used to determine the particular version of the resource.
- ETag entity tag
- the playback device 102n caches the token-to-role mapping in the edge data cache 760 (e.g., in the token-to-role mapping 761a).
- the caching is maintained for the first time-to-live period and removed from the cache when this period expires.
- the caching is considered valid for the first time-to-live period (and can't be used to resolve roles after invalidated as it is considered stale).
- the cached token-to-role mapping may be used to resolve roles for the first time-to-live period. As explained further below, certain requests may refresh the cache.
- the playback device 102n may next attempt to resolve permissions.
- the playback device 102n checks a role-to-permission cache. For instance, the playback device 102n may determine whether the edge data cache 760 includes or excludes a role-to-permission mapping corresponding to the first token (e.g., in the role-to-permission mappings 761b) ( Figure 7). Based on determining that the edge data cache 760 excludes a token- to-role mapping corresponding to the first role (i.e., a cache miss), the playback device 102n goes to the cloud to attempt to resolve the permissions.
- the playback device 102n sends a request to the authentication services 706b to resolve the permissions.
- the request includes an indication of the first role.
- the request may take the form of a HTTP GET request.
- the HTTP GET request includes the policyKey as an indication of the resolved role.
- determining the role-to-permission mapping for the first role may involve querying a database or other data storage structure for a permission set matching the role. Such a query may return an indication of the permission set corresponding to the role. An indication of such permissions may be ultimately provided to the playback device 102n in a response.
- the authentication service 706b sends a response to the request to resolve permissions.
- the response includes an indication of the permissions set corresponding to the first
- the permissions set in in the form of a permissions mask in the form of a permissions mask.
- the response also includes an indication of a second time-to-live period (TTL2), which indicates how long the permissions mask for the first role remains valid.
- TTL2 time-to-live period
- the response includes a map of namespaces to permissions bitmasks.
- the integers in the mask represent permissions for different types of commands within a namespace, similar to a Unix permissions mask.
- a namespace may define a bit-position-to-permission order within the bitmask.
- a "playlist” namespace (including playlist resources) may define a bit- position-to-permission as “create,” “read,” “update,” “delete” and “load” permissions corresponding to the least significant bit to the most significant bit, respectively.
- An HTTP example is as follows:
- a permissions mask of "18" represents permissions to READ and LOAD, but not to CREATE, UPDATE, or DELETE.
- Such permission as represented as follows:
- a permissions mask of "31" (or “11111” in binary) in the "playlist” namespace represents permissions to CREATE, READ, UPDATE, DELETE, and LOAD, which would be representative of full (e.g., owner or administrator) permissions.
- the HTTP header of the response also includes information to facilitate caching.
- the header indicates the second time-to-live period, which in this example is 86400 seconds.
- the header also includes an ETag to identify the particular version of the resource (e.g., the permissions mask). As explained in further detail below, the ETag may be used to determine whether the permissions mask has been changed (and thus needs to be re-requested from the authentication service 706b).
- role resolution and permissions resolution are intentionally separated into separate requests, as they have different usage patterns and requirements.
- a subject-to-role mapping may have a relatively short time-to-live in the edge data cache 760.
- a role-to- permissions map is less likely to change frequently and so may be cached for a longer period.
- the example first time-to-live period for the token-to-role mapping is much shorter (300 seconds) than the example second time-to-live period for the role-to-permissions mapping (86400 seconds).
- Each token-to-role mapping is unique to each client, whereas many clients may have the same role, which maps to the same permissions. As such, in certain usage scenarios, such as a house party, retail, or hospitality business, there may be many clients with unique tokens but the same role. As such, as unique guests come and go, the role-to-permissions mappings in the edge data cache 760 may be hit relatively more often (e.g,. for the same guest role) as compared with the token-to-role mappings. As such, in at least these usage patterns, caching role-to-permissions mappings may avoid relatively more server requests as compared with the token-to-role mappings. Some implementations might not utilize token-to-role mappings and instead rely only on role-to- permissions mappings as cache hits are less likely in the token-to-role mappings.
- the playback device 102n caches the role-to-permissions mapping in the edge data cache 760 (e.g., in the role-to-permissions mappings 761b).
- the caching is maintained for the second time-to-live period and removed from the cache when this period expires.
- the caching is considered valid for the second time-to-live period (and can't be used to resolve permissions after invalidated as it is considered stale).
- the cached role-to-permissions mapping may be used to resolve roles for the second time- to-live period.
- some types of requests may refresh this cached data.
- the playback device 102n may determine whether to accept or reject the command. That is, the playback device 102n may determine that the command is permitted by the resolved permission set and carry out the command at 865n. Conversely, the playback device 102n may determine that the command is prohibited by the resolved permission set and not carry out the command.
- the playback device 102n may determine whether the bitmask integer for that namespace in the permissions mask allows that client to modify volume on that object (i.e., the playback device 102n). If the command is permitted, the command is carried out.
- the command may operate on multiple playback devices (e.g., all playback devices in the group.
- a command modifying the "playback" namespace may change playback on all playback devices 102 in a group.
- some commands might operate individually.
- a command modifying the "volume" namespace may change volume an individual playback device 102 (as compared with a command modifying the "groupVolume" namespace, which may modify the volume of the group as a whole).
- the playback device 102n may provide a command result to the control device 104a.
- the command result indicates whether the command was carried out and may also indicate current resource states following the command (which may be updated if the command modified the resource). For instance, if the volume resource was modified to a different volume level, the command result may indicate the new volume level.
- the control device 104a may update a user interface (e.g., the control interfaces 540) to indicate the result of the command. For instance, if the command was carried out, a control corresponding to the corresponding resource (e.g., a
- volume slider may be updated to indicate the modified volume level. If the command was not carried out, an indication of this result may be explicitly indicated (e.g., by graying out or otherwise modifying an associated control, or an explicit message indicating that the user cannot perform this command).
- Figure 8B is another message flow diagram illustrating data exchanges between devices shown the architecture 700.
- the message flow diagram of Figure 8B represents a message flow that may occur after a client is authenticated and mappings are cached in the edge data cache 760. Further, in this example, the control device 104a already has a valid token (e.g., the first token of the Figure 8A example).
- the control device 104a sends a command to the playback device 102n.
- the client authenticates with the playback device 102n.
- the command includes the first token, which as noted above may be used to authenticate the client with the playback device 102n.
- the playback device 102n After receiving such a command, the playback device 102n attempts to resolve the role(s). In particular, at 866b, the playback device 102n checks a token-to-role cache. For instance, the playback device 102n may determine whether the edge data cache 760 includes or excludes a token-to-role mapping corresponding to the first token (e.g., in the token-to-role mappings 761a) ( Figure 7). Based on determining that the edge data cache 760 includes a token-to-role mapping corresponding to the first token (i.e., a cache hit), the playback device 102n resolves the role using the cached token-to-role mapping. Continuing the Fig. 8A example, using the cached token-to- role mapping, the playback device 102n may resolve the first token to the first role (e.g., as indicated by the policyKey) resolved in the Fig. 8A example.
- the edge data cache 760 includes or excludes a token-
- the playback device 102n After resolving the roles, the playback device 102n attempts to resolve the permissions set corresponding to the first role.
- the playback device 102n checks the role- to-permissions cache. For instance, the playback device 102n may determine whether the edge data cache 760 includes or excludes a role-to-permissions mapping corresponding to the first role (e.g., in the role-to-permissions mappings 761b) ( Figure 7). Based on determining that the edge data cache 760 includes a role-to-permissions mapping corresponding to the first role (i.e., a cache hit), the playback device 102n resolves the permissions set using the cached role-to-permissions maping. Continuing the Fig. 8A example, using the cached token-to-role mapping, the playback device 102n may resolve the first role to the first permissions sest (e.g., as indicated by the permission mask) resolved in the Fig. 8A example.
- the playback device 102n may determine whether to accept or reject the command. That is, the playback device 102n may determine that the command is permitted by the resolved permission set and carry out the command at 866d. Conversely, the playback device 102n may determine that the command is prohibited by the resolved permission set and not carry out the command.
- the playback device 102n may provide a command result to the control device 104a.
- the command result indicates whether the command was carried out and may also indicate current resource states following the command (which may be updated if the command modified the resource).
- the control device 104a may update a user interface (e.g., the control interfaces 540) to indicate the result of the command.
- the edge data cache 760 includes a mapping but the cached data is stale.
- the role-to-permission cache may include a role-to-permission mapping corresponding to the first role, but the corresponding second time-to-live period is expired, thereby indicating that the cached data is stale.
- the playback device 102n may send a conditional request (e.g., an HTTP request with an if-modified-since HTTP header) indicating the ETag of the cached role-to-permission mapping.
- the authentication service 706b can respond with a particular status (e.g., 200 status) indicating that the cached data is still the same.
- a particular status e.g. 200 status
- the authentication service 706b does not have to send the body (including the permission mask) and instead sends only the header, thereby minimizing data transmission traffic and accordingly saving on data transmission costs.
- Figure 8C is another message flow diagram illustrating data exchanges between devices shown in architecture 700 to perform authorization of another client (the control device 104b) ( Figure 7).
- the message flow diagram begins with authenticating a client.
- the control device 104b sends authentication credentials to the authentication service 706a.
- the authentication service 706a determines whether the authentication credentials are valid, and if so, sends a token to the control device 104b at 867b. This token is referred to in this example as a second token.
- control device 104a sends a command to the playback device 102n.
- the client authenticates with the
- the command includes the second token.
- the second token may be referenced in a header (e.g., an HTTP header) possibly along with other information to facilitate the command. This second token may be used to authenticate the second client with the playback device 102n.
- the playback device 102n After receiving such a command, the playback device 102n attempts to resolve the role(s). In particular, at 867d, the playback device 102n checks the token-to-role cache. For instance, the playback device 102n may determine whether the edge data cache 760 includes or excludes a token-to-role mapping corresponding to the second token (e.g., in the token-to-role mappings 761a) ( Figure 7). Based on determining that the edge data cache 760 excludes a token- to-role mapping corresponding to the second token (i.e., a cache miss), the playback device 102n goes to the cloud to attempt to resolve the roles.
- a token-to-role mapping corresponding to the second token i.e., a cache miss
- the playback device 102n sends a request for a role corresponding to the second token to the authentication service 706b.
- the request includes indications of the second token, the object (e.g., the media playback system 100, or the playback device 102n, depending on scope), and any modifications.
- the request may take the form of a HTTP POST request with the indications carried in a header.
- the authentication service 706b sends a request to validate the second token to the authentication service 706a. Then, at 867g, the authentication service 706a replies with a validation result. If the second token is valid, the validation result indicates that the second token is valid and also provides an indication of the first time-to-live period (denoted as "TTL1"). Note that this first time-to-live period may be the same duration as the first time-to-live period for the first token (or may be set differently, perhaps based on the type of client). For instance, a token for a client that has third-party software may be validated a different (e.g., shorter) time-to-live period.
- the authentication service 706b determines the token-to-role mapping for the second token. As explained above, the authentication service 706b maintains or has access to token-to-role mappings for each token. Within examples, determining the token-to-role mapping for the second token may involve querying a database or other data storage structure for a role matching the object and the second token. Such a query may return an indication of the role(s) corresponding to the second token on the object. An indication of such roles may be ultimately provided to the playback device 102n in a response.
- the authentication service 706b sends a response to the playback device 102n. If the second token is valid, the response will indicate a success and the resolved role mapping. In this example, the resolved role corresponding to the second token is referred to as a second role.
- the playback device 102n caches the token-to-role mapping in the edge data cache 760 (e.g., in the token-to-role mapping 761a).
- the caching is considered stale after expiration of the first time-to-live period. If the cache is stale, the cached data cannot be used unless a conditional request to the authentication service 706b (e.g., an if-modified-since HTTP request) indicates that the cached data is still up-to-date.
- the playback device 102n After resolving the role(s), the playback device 102n next attempts to resolve permissions. At 867j, the playback device 102n checks a role-to-permission cache. For instance, the playback device 102n may determine whether the edge data cache 760 includes or excludes a role-to-permission mapping corresponding to the second token (e.g., in the role-to-permission mappings 761b) ( Figure 7).
- the playback device 102n Based on determining that the edge data cache 760 includes a token- to-role mapping corresponding to the second role (i.e., a cache hit) but that the cached data is stale (e.g., because a time-to-live period has expired), the playback device 102n goes to the cloud to attempt to resolve the permissions.
- the playback device 102n sends a conditional request to the authentication services 706b to resolve the permissions.
- the request includes an indication of the second role and an indication of a version of the cached role-to- permission mapping corresponding to the second role.
- the request may take the form of a HTTP if-modified-since request including an ETag indicating the cached version.
- the authentication service 706b may determine whether the stale cached version of the role-to-permission mapping is still up-to-date. The authentication service 706b may make such a determination by comparing the ETag of the cached version of the role-to-permission mapping with an ETag of the version of the role-to-permission mapping at the authentication service 706b. As noted above, the ETags act as a fingerprint of the version. If the ETags match, no change has been made to the role-to-permission mapping. If the ETags are different, the version of the role-to-permission mapping at the authentication service 706b has changed and authentication service 706b responds to the request with the new mappings.
- the authentication service 706b can avoid sending the mappings and can instead respond only with an indication that the cached data previously
- Such a response may take the form of an HTTP status (e.g., 200 OK) and no body (as the mappings themselves are not necessary).
- the authentication service 706b sends a response to the request to resolve permissions indicating a status (e.g., 200 OK) and an indication of a third time-to-live period (TTL3), which indicates how long the permissions mask for the first role remains valid.
- this time-to-live period may be the same length of time as the second time-to-live period.
- the playback device 102n re-caches the role-to-permissions mapping in the edge data cache 760 (e.g., in the role-to-permissions mappings 761b).
- the caching is maintained for the second time-to-live period and considered expired after the second time-to-live period. In other examples, the caching is removed from the cache after the second time-to-live period. In either case, the cached role-to-permissions mapping may be used to resolve roles for the second time-to-live period.
- the playback device 102n may determine whether to accept or reject the command. That is, the playback device 102n may determine that the command is permitted by the resolved permission set and carry out the command at 867n. Conversely, the playback device 102n may determine that the command is prohibited by the resolved permission set and not carry out the command.
- the playback device 102n may provide a command result to the control device 104b.
- the command result indicates whether the command was carried out and may also indicate current resource states following the command (which may be updated if the command modified the resource).
- the control device 104b may update a user interface to indicate the result of the command.
- a client e.g., a web browser caches data from a web server.
- the playback device 102 including the cache e.g., the playback device 102n
- the playback device 102n is caching data on itself to respond to commands (which may take the form of HTTP requests) from one or more clients. That is, as illustrated in Figures 8B and 8C, the playback device 102n may act as an edge server itself to avoid calls to cloud services such as the authentication service 706a and the authentication service 706b.
- the playback device 102 operates as a hybrid client and server within the architecture 700.
- the playback devices 102 may support two or more different types of commands.
- the playback devices 102 may support a legacy API (e.g., universal plug-
- the playback devices may support platform API and one or more third-party (APIs), such as Airplay® or Spotify Connect®.
- APIs such as Airplay® or Spotify Connect®.
- the playback devices 102 may receive a first command according to a first API (e.g., a third party or legacy API) and map the first command to a corresponding command in another API (e.g., the platform API). After mapping, the playback devices 102 may determine whether the corresponding command is permitted by the permission set.
- a first API e.g., a third party or legacy API
- the playback devices 102 may determine whether the corresponding command is permitted by the permission set.
- the first command according to the first API may map to two or more second commands in the second API.
- determine whether the first command is permitted by a permission set may involve determining whether each of the two or more second commands are permitted.
- a playback command targeting two or more playback devices in the first API may map to a grouping command and a group playback command in the second API.
- Many other examples are possible.
- Figures 9A-9C are functional block diagrams showing examples in the example architecture 700 ( Figure 7). Such examples are intended to be representative of authentication management with various clients. Such techniques may be applied using different architectures and clients.
- Figure 9A is an example of authenticating a new client (the control device 104a) that is located on the LAN 111, which is similar to the Figure 8A example.
- the control device 104a sends authentication credentials to the authentication service 706a.
- the authentication service 706a determines whether the authentication credentials are valid, and if so, sends a token to the control device 104a at 965b.
- the control device 104a sends a command to the playback device 102n via the LAN 111.
- the command indicates the token.
- the command may take the form of an HTTP request with a header indicating the token.
- the playback device 102n After receiving the command, the playback device 102n attempts to resolve the role corresponding to the token. At 965d, the playback device 102n sends a request for a role corresponding to the token to the authentication service 706b.
- the authentication service 706b determines the token-to-role mapping for the token. As explained above, the authentication service 706b maintains or has access to token-to-role mappings for each token. Within examples, determining the token-to-role mapping for the second token may involve querying a database or
- the authentication service 706b sends a response to the playback device 102n. If the token is valid, the response will indicate a success and the resolved role mapping.
- the playback device 102n After resolving the role, the playback device 102n next attempts to resolve permissions. At 965f, the playback device 102n sends a request to resolve permissions to the authentication service 706b. The request indicates the role. The authentication service 706b resolves the permission set corresponding to the role. At 965g, the authentication service 706b sends a response indicating the permission set (as a permission mask).
- the playback device 102n may determine whether to accept or reject the command. That is, the playback device 102n may determine that the command is permitted by the resolved permission set and carry out the command. For instance, the playback device 102n may read or modify a particular namespace of the platform API. Conversely, the playback device 102n may determine that the command is prohibited by the resolved permission set and not carry out the command.
- the command targets other or additional playback devices 102 in the media playback system.
- the command may target the playback devices 102k and 1021 (and perhaps not the playback device 102, which may act as a point-of-contact for the control device 104a).
- carrying out the command may involve causing the targeted playback devices 102k and 1021 to carry out the command.
- the playback device 102 may event changes to the particular namespace over the LAN 111 to the playback devices 102k and 1021, respectively, which cause the playback devices 102k and 1021 to carry out the command.
- a command result may be sent back to the control device 104a.
- the playback device 102n sends a command result.
- one or both of the playback devices 102k and 1021 may send back a command result.
- Figure 9B is an example of authenticating a new client (the control device 104b) that is not located on the LAN 111 but instead connected to the media playback system 100 via a wide area network.
- the control device 104b sends authentication credentials to the authentication service 706a.
- the authentication service 706a determines whether the authentication credentials are valid, and if so, sends a token to the control device 104b at 966b.
- the control device 104b sends a command to the playback device 102n via an API gateway 706c.
- the API gateway 706c provides a point-of-contact outside of the LAN 111 for clients over the WAN.
- the API gateway 706c sends the command including the token to the playback device 102n.
- the playback device 102n After receiving the command, the playback device 102n attempts to resolve the role corresponding to the token. At 966e, the playback device 102n sends a request for a role corresponding to the token to the authentication service 706b. The authentication service 706b determines the token-to-role mapping for the token. At 966f, the authentication service 706b sends a response to the playback device 102n. If the token is valid, the response will indicate a success and the resolved role mapping.
- the playback device 102n After resolving the role, the playback device 102n next attempts to resolve permissions.
- the role-to-permission caching is cached in the edge data cache 760.
- the playback device 102n can resolve the permission set without communicating again with the authentication service 706b.
- the playback device 102n may determine whether to accept or reject the command. That is, the playback device 102n may determine that the command is permitted by the resolved permission set and carry out the command. Conversely, the playback device 102n may determine that the command is prohibited by the resolved permission set and not carry out the command.
- Figure 9C is an example of authenticating a new client (the NMD 103f) that is located on the LAN 111 but includes third-party software (e.g., to process voice inputs via the VAS 190).
- the NMD 103f sends a voice input to the computing devices 106a.
- the computing devices 106a sends authentication credentials to the authentication service 706a.
- the authentication service 706a determines whether the authentication credentials are valid, and if so, sends a token to the computing devices 106a at 967c.
- the computing devices 106a send a command to the playback device 102n via the API gateway 706c.
- the API gateway 706c provides a point-of-contact outside of the LAN 111 for clients over the WAN.
- the API gateway 706c sends the command including the token to the playback device 102n.
- the playback device 102n After receiving the command, the playback device 102n attempts to resolve the role corresponding to the token. At 967f, the playback device 102n sends a request for a role
- the authentication service 706b determines the token-to-role mapping for the token.
- the authentication service 706b sends a response to the playback device 102n. If the token is valid, the response will indicate a success and the resolved role mapping.
- the playback device 102n After resolving the role, the playback device 102n next attempts to resolve permissions.
- the role-to-permission caching is cached in the edge data cache 760.
- the playback device 102n can resolve the permission set without communicating again with the authentication service 706b.
- the playback device 102n may determine whether to accept or reject the command. That is, the playback device 102n may determine that the command is permitted by the resolved permission set and carry out the command. Conversely, the playback device 102n may determine that the command is prohibited by the resolved permission set and not carry out the command.
- F igure 10 is a flow diagram showing an example method 1000 to authenticate a client and carry out a restricted command.
- the method 1000 may be performed by one or more playback device(s) 102.
- the method 1000 may be performed by any suitable device or by a system of devices, such as the playback devices 102, the NMDs 103, control devices 104, computing devices 105, computing devices 106, or by smart IOT devices (such as the smart illumination device 108 or smart thermostat 110).
- smart IOT devices such as the smart illumination device 108 or smart thermostat 110.
- the method 1000 involves (i) receiving data representing a playback command and (ii) a token corresponding to a client.
- the playback device 102n may receive, via a first network interface, first data representing (i) a first playback command and (ii) a first token corresponding to a first client, such as the control device 104a ( Figures 7, 8A-8B).
- first client and the playback device are connected to a local area network ( Figure 9A).
- clients are not connected to the local area network (e.g., Figure 9B).
- the method 1000 involves resolving a role corresponding to the token.
- the playback device 102n and the authentication service 706b may resolve a first
- the playback device 102n may resolve a first role corresponding to the first token using an edge data cache ( Figure 8B).
- the playback device 102n may cache, in the edge data cache, the first token-to-role mapping that maps the first token to the first role ( Figures 8A and 8C).
- the playback device 102n may determine that an edge data cache (e.g., the edge data cache 760) excludes a token-to-role mapping corresponding to the first token (e.g., 865d in Figure 8A).
- the playback device 102n may send, via the first network interface to the computing system, a request for a role corresponding to the first token (e.g., 865e in Figure 8A).
- the platform servers 706 may receive, via a second network interface, the request for the role corresponding to the first token and determine, based on stored role-to-token mappings for a plurality of media playback systems, a first token-to-role mapping that maps the first token to a first role for the media playback system (Figure 8A).
- the platform servers 706 may send, via the second network interface to the playback device, data representing the first token-to-role mapping for the media playback system and the playback device 102n may receive, via the network interface, a response to the request indicating the first token-to-role mapping that maps the first token to the first role (e.g., 865h in Figure 8A).
- the playback device 102n may determine that an edge data cache (e.g., the edge data cache 760) includes a token-to-role mapping corresponding to the first token (e.g., 866b in Figure 8B). In such an example, the playback device 102n may resolve the first role based on the edge data cache (e.g., based on a cached token-to-role mapping in the edge data cache 760). In a further example, when cached data in the edge data cache is stale, the playback device 102n may resolve the first role based on a conditional request (Figure 8C).
- an edge data cache e.g., the edge data cache 760
- a token-to-role mapping corresponding to the first token e.g., 866b in Figure 8B
- the playback device 102n may resolve the first role based on the edge data cache (e.g., based on a cached token-to-role mapping in the edge data cache 760).
- the method 1100 involves resolving the permission set corresponding to the resolved role.
- the playback device 102n and the authentication service 706b may resolve a first permission set corresponding to the first role ( Figures 8A) based on a role-to- permission mapping.
- the playback device 102n may resolve the first permission set corresponding to the first role using an edge data cache ( Figure 8B).
- the permission set may be represented as a permission mask.
- the playback device 102m may determine that the edge data cache includes a first role-to-permission mapping corresponding to the first role (e.g., 866c in Figure 8B)
- the first role-to-permission mapping maps the first role to a first permission set.
- playback device 102 may resolve the first permission set using the cached first role-to-permission mapping.
- the playback device 102n may determine that the edge data cache excludes a role-to-permission mapping corresponding to the first token (e.g., 865j in Figure 8A).
- the playback device 102n may send, via the first network interface to the computing system, a request for a permission set corresponding to the first role (e.g., 865k in Figure 8A).
- the platform servers 706 may receive, via a second network interface, the request for the permission set corresponding to the first token and determine, based on stored role-to-permission mappings for a plurality of media playback systems, a first role-to-permission mapping that maps the first role to a first permission set for the media playback system ( Figure 8 A).
- the platform servers 706 may send, via the second network interface to the playback device, data representing the first role-to- permission mapping for the media playback system and the playback device 102n may receive, via the network interface, a response to the request indicating the first role-to-permission mapping (e.g., 8651 in Figure 8A).
- the playback device 102n may receive, via the network interface, a response to the request indicating the first role-to-permission mapping (e.g., 8651 in Figure 8A).
- the method 100 involves determining that the playback command is permitted by the resolved permission set.
- the playback device 102n may determine that the playback command is permitted based on a namespace of a resource being created, read, deleted, modified, or otherwise referenced and a portion of a bitmask indicating permission (or not) for that action (Figure 8A). Other examples are possible as well.
- the method 1000 involves carrying out the playback command.
- the playback device 102n may carry out the playback command on itself.
- the playback device 102n may carry out the playback command on the group or on the targeted playback devices.
- the method 100 involves caching in an edge data cache (e.g., the edge data cache 760).
- the playback device 102n may cache, in the edge data cache, the token-to-role mappings that maps tokens to the corresponding roles ( Figure 8A).
- the playback device 102n may cache, in the edge data cache, permission-to-role mappings that map the permissions to the corresponding roles ( Figure 8A).
- the method 1000 involves authenticating additional clients and carrying out additional commands from such clients. Further variations and functions that may be
- At least one of the elements in at least one example is hereby expressly defined to include a tangible, non-transitory medium such as a memory, DVD, CD, Blu-ray, and so on, storing the software and/or firmware.
- Example 1 A method to be performed in a system comprising a first playback device, the method comprising: receiving, via a first network interface, first data representing (i) a first playback command and (ii) a first token corresponding to a first client; determining that an edge data cache excludes a token-to-role mapping corresponding to the first token; sending, via the first network interface to a computing system, a request for a role corresponding to the first token; receiving, via the first network interface, a response to the request indicating a first token- to-role mapping that maps the first token to a first role; when the edge data cache excludes the token-to-role mapping corresponding to the first token, caching, in the edge data cache, the first token-to-role mapping that maps the first token to the first role; determining that the edge data cache includes a first role-to-permission mapping corresponding to the first role, wherein the first role-to-permission mapping maps the first role to a first permission set;
- Example 2 The method of Example 1, wherein the system further comprises the computing system, and wherein the method further comprises: receiving, via the second network interface, the request for the role corresponding to the first token; determining, based on stored role-to-token mappings for a plurality of media playback systems, the first token-to-role mapping that maps the first token to the first role for the media playback system; and sending, via the second network interface to the playback device, data representing the first token-to-role mapping for the media playback system.
- Example 3 The method of any of Examples 1-2, further comprising: after caching the first token-to-role mapping in the edge data cache, receiving, via the first network interface, second data representing (i) a second playback command and (ii) a second token corresponding to the first client; determining that the edge data cache includes the token-to-role mapping corresponding to the first token; determining that the edge data cache includes the first role-to- permission mapping corresponding to the first role; determining that the second playback command is permitted by the first permission set; and based on determining that the second
- Example 4 The method of any of Examples 1-3, further comprising: receiving, via the first network interface, third data representing (i) a third playback command and (ii) a second token corresponding to a second client; determining that the edge data cache excludes a token-to- role mapping corresponding to the second token; sending, via the first network interface to the computing system, a request for a role corresponding to the second token; receiving, via the first network interface, a response to the request indicating a second token-to-role mapping that maps the second token to a second role; when the edge data cache excludes the token-to-role mapping corresponding to the second token, caching, in the edge data cache, a second token-to-role mapping that maps the second token to the second role; determining that the edge data cache excludes a second role-to-permission mapping corresponding to the second role; sending, via the first network interface to the computing system, a request for a permission set corresponding to the second role; receiving, via the first network interface
- Example 5 The method of Example 4, further comprising: receiving, via the first network interface, fourth data representing (i) a fourth playback command and (ii) the second token corresponding to the second client; determining that the edge data cache includes the token- to-role mapping corresponding to the second token; determining that the edge data cache includes a second role-to-permission mapping corresponding to the second role and that the second role- to-permission mapping is stale as a time-to-live period has expired; sending, via the first network interface to the computing system, a conditional request for a permission set corresponding to the second role, the conditional request indicating a version of the second role-to-permission mapping in the edge data cache; receiving, via the first network interface, a response to the request indicating that the version of the second role-to-permission mapping in the edge data cache matches a version of the second role-to-permission mapping at the computing system; when the response to the request indicating that the version of the second role-to-permission mapping in the
- edge data cache matches a version of the second role-to-permission mapping at the computing system, re-caching, in the edge data cache, the second role-to-permission mapping that maps the second role to the second permission set for another iteration of the time-to-live period; determining that the fourth playback command is permitted by the second permission set; and based on determining that the fourth playback command is permitted by the second permission set, carrying out the fourth playback command.
- Example 6 The method of any of Examples 1-5, wherein the system further comprises the computing system, and wherein the method further comprises: receiving, via the second network interface, the request for the permission set corresponding to the second role; determining, based on stored role-to-permission mappings, the second role-to-permission mapping that maps the second role to the second permission set; and sending, via the second network interface to the playback device, data representing the second role-to-permission mapping.
- Example 7 The method of any of Examples 1-6, further comprising: before determining that the edge data cache includes the first role-to-permission mapping corresponding to the first role, sending, via the first network interface, a request for the first permission set corresponding to the first role; and caching, in the edge data cache, the first role-to-permission mapping that maps the first role to the first permission set.
- Example 8 The method of any of Examples 1-7, wherein the first client comprises an application executing on a mobile device, and wherein the functions further comprise: sending, via the first network interface to the mobile device, data representing a result of the first playback command, wherein the data representing the result of the first playback command causes the application to update a graphical user interface displayed on the mobile device to indicate the result of the first playback command.
- Example 9 The method of any of Examples 1-8, wherein the first playback command is a volume adjustment command, and wherein the first permission set comprises a first permission mask comprising digits settable to values corresponding to a read permission or a modify permission, the digits comprising a volume permission digit, and wherein determining that the first playback command is permitted by the first permission set comprises determining that the volume permission digit indicates a value corresponding to the modify permission.
- Example 10 The method of any of Examples 1-9, wherein receiving the first data representing the first playback command comprises receiving data representing a first universal plug-and play (UPnP) command, and wherein determining that the first playback command is permitted by the first permission set comprises: mapping the first UPnP command to a corresponding first media playback system command; and determining that the first media playback system command is permitted by the first permission set.
- UPnP universal plug-and play
- Example 11 The method of any of Examples 1-10, further comprising: receiving, via the first network interface, fifth data representing (i) a fifth playback command, wherein the fifth data excludes a token; determining that the edge data cache excludes a token-to-role mapping corresponding to a token absence; sending, via the first network interface to the computing system, a request for a role corresponding to the token absence; receiving, via the first network interface, a response to the request indicating a token-to-role mapping that maps the token absence to the first role; determining that the edge data cache includes the first role-to-permission mapping corresponding to the first role; determining that the fourth playback command is prohibited by the first permission set; and based on determining that the fourth playback command is prohibited by the first permission set, foregoing carrying out the fourth playback command.
- Example 12 The method of any of Examples 1-11, wherein carrying out the first playback command comprises causing at least one additional playback device of the media playback system to carry out the first playback command.
- Example 13 The method of any of Examples 1-12, wherein the system further comprises the computing system, and wherein the method further comprises: validating the first token, and wherein determining the first token-to-role mapping that maps the first token to the first role for the media playback system comprises determining a particular first token-to-role mapping that maps the validated first token to the first role for the media playback system, wherein an invalid token maps to another role that is different from the first role.
- Example 14 The method of any of Examples 1-13, further comprising: before determining that the edge data cache includes the first role-to-permission mapping corresponding to the first role, sending, via the first network interface to the computing system, an if-modified- since request for a role-to-permission mapping corresponding to the first role, the if-modified- since request indicating a particular time and date;
- Example 15 The method of any preceding Example, receiving, via the first network interface, a response to the if-modified-since request indicating that the role-to-permission mapping corresponding to the first role is modified since the particular time and date, wherein the response indicates the first role-to-permission mapping that maps the first role to the first permission set; and caching, in the edge data cache, the first role-to-permission mapping that maps the first role to the first permission set.
- Example 16 A tangible, non-transitory, computer-readable medium having instructions stored thereon that are executable by one or more processors to cause a system to perform the method of any one of Examples 1-15.
- Example 17 A device comprising a network interface, one or more processors, and a tangible, non-tangible computer-readable medium having instructions stored thereon that are executable by the one or more processors to cause the system to perform the method of any of Examples 1-15.
- Example 18 A system comprising a network interface, one or more processors, and a tangible, non-tangible computer-readable medium having instructions stored thereon that are executable by the one or more processors to cause the system to perform the method of any of Examples 1-15.
Landscapes
- Engineering & Computer Science (AREA)
- Computer Security & Cryptography (AREA)
- Theoretical Computer Science (AREA)
- Signal Processing (AREA)
- Multimedia (AREA)
- General Engineering & Computer Science (AREA)
- Computer Hardware Design (AREA)
- General Physics & Mathematics (AREA)
- Physics & Mathematics (AREA)
- Databases & Information Systems (AREA)
- Software Systems (AREA)
- General Health & Medical Sciences (AREA)
- Computer Graphics (AREA)
- Health & Medical Sciences (AREA)
- Computing Systems (AREA)
- Computer Networks & Wireless Communication (AREA)
- Human Computer Interaction (AREA)
- Bioethics (AREA)
- Audiology, Speech & Language Pathology (AREA)
- Information Transfer Between Computers (AREA)
Abstract
Example techniques described herein involve authorization management in a media playback system. Within examples, a client, such as a control device, may authenticate with a playback device using a token. The playback device may resolve a role corresponding to the token using a token-to-role mapping hosted at an authentication service. After resolving the role, the playback device may resolve a permissions set corresponding to the role using a role-to-permissions mapping similarly hosted at the authentication service. Within examples, such mappings may be cached locally at the edge (e.g., on a playback device).
Description
AUTHORIZATION MANAGEMENT IN A MEDIA PLAYBACK SYSTEM
CROSS-REFERENCE TO RELATED APPLICATIONS
[0001] The present application claims the benefit of priority to U.S. Patent Application No. 63/186,520, filed May 10, 2021 and U.S. Patent Application No. 17/662,530, filed May 9, 2022, which are incorporated herein by reference in their entireties.
FIELD OF THE DISCLOSURE
[0002] The present technology relates to consumer goods and, more particularly, to methods, systems, products, features, services, and other elements directed to voice-assisted control of media playback systems or some aspect thereof.
BACKGROUND
[0003] Options for accessing and listening to digital audio in an out-loud setting were limited until in 2002, when SONOS, Inc. began development of a new type of playback system. Sonos then filed one of its first patent applications in 2003, entitled “Method for Synchronizing Audio Playback between Multiple Networked Devices,” and began offering its first media playback systems for sale in 2005. The Sonos Wireless Home Sound System enables people to experience music from many sources via one or more networked playback devices. Through a software control application installed on a controller (e.g., smartphone, tablet, computer, voice input device), one can play what she wants in any room having a networked playback device. Media content (e.g., songs, podcasts, video sound) can be streamed to playback devices such that each room with a playback device can play back corresponding different media content. In addition, rooms can be grouped together for synchronous playback of the same media content, and/or the same media content can be heard in all rooms synchronously.
BRIEF DESCRIPTION OF THE DRAWINGS
[0004] Features, aspects, and advantages of the presently disclosed technology may be better understood with regard to the following description, appended claims, and accompanying drawings where:
[0005] Features, aspects, and advantages of the presently disclosed technology may be better understood with regard to the following description, appended claims, and accompanying drawings, as listed below. A person skilled in the relevant art will understand that the features
1
shown in the drawings are for purposes of illustrations, and variations, including different and/or additional features and arrangements thereof, are possible.
[0006] Figure 1A is a partial cutaway view of an environment having a media playback system configured in accordance with aspects of the disclosed technology.
[0007] Figure IB is a schematic diagram of the media playback system of Figure 1A and one or more networks.
[0008] Figure 2A is a functional block diagram of an example playback device.
[0009] Figure 2B is an isometric diagram of an example housing of the playback device of
Figure 2 A.
[0010] Figure 2C is a diagram of an example voice input.
[0011] Figure 2D is a graph depicting an example sound specimen in accordance with aspects of the disclosure.
[0012] Figures 3A, 3B, 3C, 3D and 3E are diagrams showing example playback device configurations in accordance with aspects of the disclosure.
[0013] Figure 4 is a functional block diagram of an example controller device in accordance with aspects of the disclosure.
[0014] Figures 5A and 5B are controller interfaces in accordance with aspects of the disclosure.
[0015] Figure 6 is a message flow diagram of a media playback system.
[0016] Figure 7 is functional block diagrams illustrating an example authorization management architecture in accordance with aspects of the disclosed technology.
[0017] Figures 8A, 8B, and 8C are example message flow diagrams illustrating example authorization management in accordance with aspects of the disclosed technology.
[0018] Figures 9A, 9B, and 9C are functional block diagrams illustrating example authorization management in accordance with aspects of the disclosed technology.
[0019] Figure 10 is a flow diagram of an example method to process command intermediates in accordance with aspects of the disclosed technology.
[0020] The drawings are for purposes of illustrating example embodiments, but it should be understood that the inventions are not limited to the arrangements and instrumentality shown in
2
the drawings. In the drawings, identical reference numbers identify at least generally similar elements. To facilitate the discussion of any particular element, the most significant digit or digits of any reference number refers to the Figure in which that element is first introduced. For example, element 103a is first introduced and discussed with reference to Figure 1A.
DETAILED DESCRIPTION I. Overview
[0021] Example techniques described herein involve authorization management in a media playback system. A media playback system may include one or more playback devices, which may take the form of "smart" speakers having integrated processors, memory, operating systems, and applications configured to perform audio playback and related functions. Such audio playback and other functions of the playback device(s) are controllable using a controller, such as a control application installed on another computing device (e.g., a mobile device or laptop) via network messaging (e.g., via a local area network). Certain actions require a client (e.g., a controller) to be authenticated and provided a set of permissions before the client can access restricted data (e.g., state information) or perform restricted actions on the playback device.
[0022] Example authorization management may involve authenticating a client. Example clients include controllers, which may be first-party (e.g., a controller application developed by the manufacturer of the media playback system to provide control functionality) and third-party (e.g., applications developed by various content services, such as streaming audio services, that support one or more application programming interfaces (API)s to enable control of the playback devices within the media playback system. An client may send authentication credentials (e.g., a user name/password, a pin, scanned token, client SSL certificate, among other examples) to a first authentication service (e.g., AuthN) executing on a computing system (e.g., a cloud computing system). In return, the authentication service provides a token (e.g., an OAuth token) to the client.
[0023] The client may then authenticate with the playback devices using the token. For instance, when performing a restricted action on a playback device, the client may send the token to the playback device. Example control protocols or APIs may utilize HTTP requests and responses. In such examples, the token may be transmitted using HTTP headers. The token authenticates the client (i.e., this client is who they say they are), but might not be configured with any additional information about the client's "role."
3
[0024] In role-based access control, a subject (e.g., the client) has a role on the object. In an example, the media playback system (and all constituent playback devices in the household) are the object. In such an example, the client may have a certain role with respect to all of the playback devices in the system. In other examples, the media playback system may be divided into two or more objects (e.g., based on rooms or zones configured within the media playback system). In this example, a client may have different roles in different zones (or may have the same role in all zones).
[0025] Within examples, the playback device may resolve a role for the client. A second authentication service (e.g., AuthZ) executing on a computing system (e.g., on a cloud computing system) may maintain token-to-role mappings to facilitate role resolution. For instance, after receiving a token from a client, the playback device may send the token to the second authentication service, which may return a set of effective roles for that token.
[0026] To reduce queries to the second authentication service, the playback device may maintain an edge data cache in data storage on the playback device that includes token-to-role mappings. After a successful query to the second authentication service, the playback device may store a received token-to-role mapping in the edge data cache. Then, when receiving the token again, the playback device may check the edge data cache first and, if the token-to-role mapping is in the edge data cache (i.e., a cache hit), the playback device may resolve the role using this mapping rather than querying the second authentication service. If the token-to-role mapping is not found in the edge data cache (i.e., a cache miss, perhaps because the mapping had expired or the mapping had not yet been queried), the playback device can query to second authentication service.
[0027] After resolving the role for the client on the subject, authorization management may further involve resolving permissions for the role. Within examples, the second authentication service (e.g., AuthZ) may maintain role-to-permissions mappings to facilitate permissions resolution. For instance, after receiving a role, the playback device may send the role to the second authentication service, which may return a set of permissions for that token. This role-to- permission mapping may be cached in the edge data cache, and used for subsequent permissions resolutions. Generally, by caching such data in an edge data cache and resolving roles and permissions at the edge, requests to the cloud may be reduced, which may ultimately reduce data transmission costs.
4
[0028] Example roles include owner and guest. In an example implementation, an owner role may have full permissions on their media playback system while a guest may have reduced roles. Since roles operate on subjects (e.g., media playback systems), a given client may have one role (e.g., owner) on their own media playback system and a different role (e.g., guest) on other media playback systems (e.g., a media playback system belonging to their friend).
[0029] The set of permissions may be in the form of a permissions mask with different integers in the mask represent permissions for different types of commands, similar to a Unix permissions mask. In an example, read permissions are represented using the T integer while read and modify permissions are represented using the '3' integer. In such an example, a guest role may have a 133 mask with the first digit corresponding to a "groups" namespace (representing permission to read but not modify groups), the second digit corresponding to a "playback" namespace (representing permission to read current playback status and modify the state), and the third digit corresponding to a "volume" namespace (representing permission to read current volume status and modify it).
[0030] In this example, role resolution and permissions resolutions are intentionally separated. To facilitate quick revocation of access, a subj ect-to-role mapping may have a relatively short time-to-live in the edge data cache. Moreover, in certain usage scenarios, such as a house party, retail, or hospitality business, there may be many concurrent subjects mapping to the same role (e.g., a guest role). In contrast, a role-to-permissions map is less likely to change frequently and may apply to a larger set of clients. As such, a cached role-to-permissions map may have a relatively longer time-to-live and may be able to avoid a relatively higher number of requests to the second authentication service.
[0031] After authenticating the client, resolving the role for that client, and resolving permissions for the client, the playback device may apply permissions. For instance, the playback device may determine whether the received playback command is permitted by the permissions for that client. For instance, following the example above, if the permission mask is 133 and the command is to change volume level, the playback device may determine based on the '3' digit in the volumes namespace that this client has permissions to change the volume. The playback device may then carry out the command.
[0032] As noted above, example techniques relate to authentication management in a media playback system. An example implementation involves a system comprising a first playback
5
device, wherein the first playback device comprises, a network interface, at least one processor and data storage including instructions that are executable by the at least one processor such that the first playback device is configured to: receive, via the network interface, first data representing (i) a first playback command and (ii) a first token corresponding to a first client, wherein the first client and the playback device are connected to a local area network; determine that an edge data cache excludes a token-to-role mapping corresponding to the first token; send, via the network interface to the computing system, a request for a role corresponding to the first token, wherein the computing system is outside of the local area network; receive, via the network interface, a response to the request indicating a first token-to-role mapping that maps the first token to a first role; when the edge data cache excludes the token-to-role mapping corresponding to the first token, cache, in the edge data cache for a first time-to-live period, the first token-to-role mapping that maps the first token to the first role; determine that the edge data cache includes a first role- to-permission mapping corresponding to the first role, wherein the first role-to-permission mapping maps the first role to a first permission set; determine that the first playback command is permitted by the first permission set, and based on determining that the first playback command is permitted by the first permission set, carrying out the first playback command.
[0033] While some embodiments described herein may refer to functions performed by given actors, such as “users” and/or other entities, it should be understood that this description is for purposes of explanation only. The claims should not be interpreted to require action by any such example actor unless explicitly required by the language of the claims themselves.
[0034] Moreover, some functions are described herein as being performed "based on" or "in response to" another element or function. "Based on" should be understood that one element or function is related to another function or element. "In response to" should be understood that one element or function is a necessary result of another function or element. For the sake of brevity, functions are generally described as being based on another function when a functional link exists; however, such disclosure should be understood as disclosing either type of functional relationship.
II. Example Operation Environment
[0035] Figures 1A and IB illustrate an example configuration of a media playback system 100 (or “MPS 100”) in which one or more embodiments disclosed herein may be implemented. Referring first to Figure 1A, the MPS 100 as shown is associated with an example home environment having a plurality of rooms and spaces, which may be collectively referred to as a
6
“home environment,” “smart home,” or “environment 101.” The environment 101 comprises a household having several rooms, spaces, and/or playback zones, including a master bathroom 101a, a master bedroom 101b, (referred to herein as “Nick’s Room”), a second bedroom 101c, a family room or den lOld, an office lOle, a living room lOlf, a dining room lOlg, a kitchen lOlh, and an outdoor patio lOli. While certain embodiments and examples are described below in the context of a home environment, the technologies described herein may be implemented in other types of environments. In some embodiments, for example, the MPS 100 can be implemented in one or more commercial settings (e.g., a restaurant, mall, airport, hotel, a retail or other store), one or more vehicles (e.g., a sports utility vehicle, bus, car, a ship, a boat, an airplane), multiple environments (e.g., a combination of home and vehicle environments), and/or another suitable environment where multi-zone audio may be desirable.
[0036] Within these rooms and spaces, the MPS 100 includes one or more computing devices. Referring to Figures 1A and IB together, such computing devices can include playback devices 102 (identified individually as playback devices 102a-102n), network microphone devices 103 (identified individually as “NMDs” 103a-102i), and controller devices 104a and 104b (collectively “controller devices 104”). Referring to Figure IB, the home environment may include additional and/or other computing devices, including local network devices, such as one or more smart illumination devices 108 (Figure IB), a smart thermostat 110, and a local computing device 105 (Figure 1A).
[0037] With reference still to Figure IB, the various playback, network microphone, and controller devices 102, 103, and 104 and/or other network devices ofthe MPS 100 may be coupled to one another via point-to-point connections and/or over other connections, which may be wired and/or wireless, via a network 111, such as a LAN including a network router 109. For example, the playback device 102j in the Den 101 d (Figure 1A), which may be designated as the “Left” device, may have a point-to-point connection with the playback device 102a, which is also in the Den lOld and may be designated as the “Right” device. In a related embodiment, the Left playback device 102j may communicate with other network devices, such as the playback device 102b, which may be designated as the “Front” device, via a point-to-point connection and/or other connections via the NETWORK 111.
[0038] As further shown in Figure IB, the MPS 100 may be coupled to one or more remote computing devices 106 via a wide area network (“WAN”) (i.e., the Internet), labeled here as the networks 107. In some embodiments, each remote computing device 106 may take the form of
7
one or more cloud servers. The remote computing devices 106 may be configured to interact with computing devices in the environment 101 in various ways. For example, the remote computing devices 106 may be configured to facilitate streaming and/or controlling playback of media content, such as audio, in the home environment 101.
[0039] In some implementations, the various playback devices, NMDs, and/or controller devices 102-104 may be communicatively coupled to at least one remote computing device associated with a VAS and at least one remote computing device associated with a media content service (“MCS”). For instance, in the illustrated example of Figure IB, remote computing devices 106 are associated with a VAS 190 and remote computing devices 106b are associated with an MCS 192. Although only a single VAS 190 and a single MCS 192 are shown in the example of Figure IB for purposes of clarity, the MPS 100 may be coupled to multiple, different VASes and/or MCSes. In some implementations, VASes may be operated by one or more of AMAZON, GOOGLE, APPLE, MICROSOFT, SONOS or other voice assistant providers. In some implementations, MCSes may be operated by one or more of SPOTIFY, PANDORA, AMAZON MUSIC, or other media content services. Media content services are also referred to herein as streaming audio services.
[0040] As further shown in Figure IB, the remote computing devices 106 further include remote computing device 106c configured to perform certain operations, such as remotely facilitating media playback functions, managing device and system status information, directing communications between the devices of the MPS 100 and one or multiple VASes and/or MCSes, among other operations. In one example, the remote computing devices 106c provide cloud servers for one or more SONOS Wireless HiFi Systems.
[0041] In various implementations, one or more of the playback devices 102 may take the form of or include an on-board (e.g., integrated) network microphone device. For example, the playback devices 102a-e include or are otherwise equipped with corresponding NMDs 103a-e, respectively. A playback device that includes or is equipped with an NMD may be referred to herein interchangeably as a playback device or an NMD unless indicated otherwise in the description. In some cases, one or more of the NMDs 103 may be a stand-alone device. For example, the NMDs 103f and 103g may be stand-alone devices. A stand-alone NMD may omit components and/or functionality that is typically included in a playback device, such as a speaker or related electronics. For instance, in such cases, a stand-alone NMD may not produce audio output or may produce limited audio output (e.g., relatively low-quality audio output).
8
[0042] The various playback and network microphone devices 102 and 103 of the MPS 100 may each be associated with a unique name, which may be assigned to the respective devices by a user, such as during setup of one or more of these devices. For instance, as shown in the illustrated example of Figure IB, a user may assign the name “Bookcase” to playback device 102d because it is physically situated on a bookcase. Similarly, the NMD 103f may be assigned the named “Island” because it is physically situated on an island countertop in the kitchen lOlh (Figure 1A). Some playback devices may be assigned names according to a zone or room, such as the playback devices 102e, 1021, 102m, and 102n, which are named “Bedroom,” “Dining Room,” “Living Room,” and “Office,” respectively. Further, certain playback devices may have functionally descriptive names. For example, the playback devices 102a and 102b are assigned the names “Right” and “Front,” respectively, because these two devices are configured to provide specific audio channels during media playback in the zone of the Den 101 d (Figure 1A). The playback device 102c in the Patio may be named portable because it is battery-powered and/or readily transportable to different areas of the environment 101. Other naming conventions are possible.
[0043] As discussed above, an NMD may detect and process sound from its environment, such as sound that includes background noise mixed with speech spoken by a person in the NMD’s vicinity. For example, as sounds are detected by the NMD in the environment, the NMD may process the detected sound to determine if the sound includes speech that contains voice input intended for the NMD and ultimately a particular VAS. For example, the NMD may identify whether speech includes a wake word associated with a particular VAS.
[0044] In the illustrated example of Figure IB, the NMDs 103 are configured to interact with the VAS 190 over a network via the network 111 and the router 109. Interactions with the VAS 190 may be initiated, for example, when an NMD identifies in the detected sound a potential wake word. The identification causes a wake-word event, which in turn causes the NMD to begin transmitting detected-sound data to the VAS 190. In some implementations, the various local network devices 102-105 (Figure 1A) and/or remote computing devices 106c of the MPS 100 may exchange various feedback, information, instructions, and/or related data with the remote computing devices associated with the selected VAS. Such exchanges may be related to or independent of transmitted messages containing voice inputs. In some embodiments, the remote computing device(s) and the MPS 100 may exchange data via communication paths as described herein and/or using a metadata exchange channel as described in U.S. Application No. 15/438,749
9
filed February 21, 2017, and titled “Voice Control of a Media Playback System,” which is herein incorporated by reference in its entirety.
[0045] Upon receiving the stream of sound data, the VAS 190 determines if there is voice input in the streamed data from the NMD, and if so the VAS 190 will also determine an underlying intent in the voice input. The VAS 190 may next transmit a response back to the MPS 100, which can include transmitting the response directly to the NMD that caused the wake-word event. The response is typically based on the intent that the VAS 190 determined was present in the voice input. As an example, in response to the VAS 190 receiving a voice input with an utterance to “Play Hey Jude by The Beatles,” the VAS 190 may determine that the underlying intent of the voice input is to initiate playback and further determine that intent of the voice input is to play the particular song “Hey Jude.” After these determinations, the VAS 190 may transmit a command to a particular MCS 192 to retrieve content (i.e., the song “Hey Jude”), and that MCS 192, in turn, provides (e.g., streams) this content directly to the MPS 100 or indirectly via the VAS 190. In some implementations, the VAS 190 may transmit to the MPS 100 a command that causes the MPS 100 itself to retrieve the content from the MCS 192.
[0046] In certain implementations, NMDs may facilitate arbitration amongst one another when voice input is identified in speech detected by two or more NMDs located within proximity of one another. For example, the NMD-equipped playback device 102d in the environment 101 (Figure 1A) is in relatively close proximity to the NMD-equipped Living Room playback device 102m, and both devices 102d and 102m may at least sometimes detect the same sound. In such cases, this may require arbitration as to which device is ultimately responsible for providing detected-sound data to the remote VAS. Examples of arbitrating between NMDs may be found, for example, in previously referenced U.S. Application No. 15/438,749.
[0047] In certain implementations, an NMD may be assigned to, or otherwise associated with, a designated or default playback device that may not include an NMD. For example, the Island NMD 103f in the kitchen lOlh (Figure 1A) may be assigned to the dining room playback device 1021, which is in relatively close proximity to the Island NMD 103f. In practice, an NMD may direct an assigned playback device to play audio in response to a remote VAS receiving a voice input from the NMD to play the audio, which the NMD might have sent to the VAS in response to a user speaking a command to play a certain song, album, playlist, etc. Additional details regarding assigning NMDs and playback devices as designated or default devices may be found, for example, in previously referenced U.S. Patent Application No.
10
[0048] Further aspects relating to the different components of the example MPS 100 and how the different components may interact to provide a user with a media experience may be found in the following sections. While discussions herein may generally refer to the example MPS 100, technologies described herein are not limited to applications within, among other things, the home environment described above. For instance, the technologies described herein may be useful in other home environment configurations comprising more or fewer of any of the playback, network microphone, and/or controller devices 102-104. For example, the technologies herein may be utilized within an environment having a single playback device 102 and/or a single NMD 103. In some examples of such cases, the NETWORK 111 (Figure IB) may be eliminated and the single playback device 102 and/or the single NMD 103 may communicate directly with the remote computing devices 106-d. In some embodiments, a telecommunication network (e.g., an LTE network, a 5G network, etc.) may communicate with the various playback, network microphone, and/or controller devices 102-104 independent of a LAN. a. Example Playback & Network Microphone Devices
[0049] Figure 2A is a functional block diagram illustrating certain aspects of one of the playback devices 102 of the MPS 100 of Figures 1A and IB. As shown, the playback device 102 includes various components, each of which is discussed in further detail below, and the various components of the playback device 102 may be operably coupled to one another via a system bus, communication network, or some other connection mechanism. In the illustrated example of Figure 2A, the playback device 102 may be referred to as an “NMD-equipped” playback device because it includes components that support the functionality of an NMD, such as one of the NMDs 103 shown in Figure 1A.
[0050] As shown, the playback device 102 includes at least one processor 212, which may be a clock-driven computing component configured to process input data according to instructions stored in memory 213. The memory 213 may be a tangible, non-transitory, computer-readable medium configured to store instructions that are executable by the processor 212. For example, the memory 213 may be data storage that can be loaded with software code 214 that is executable by the processor 212 to achieve certain functions.
[0051] In one example, these functions may involve the playback device 102 retrieving audio data from an audio source, which may be another playback device. In another example, the functions may involve the playback device 102 sending audio data, detected-sound data (e.g., corresponding to a voice input), and/or other information to another device on a network via at
11
least one network interface 224. In yet another example, the functions may involve the playback device 102 causing one or more other playback devices to synchronously playback audio with the playback device 102. In yet a further example, the functions may involve the playback device 102 facilitating being paired or otherwise bonded with one or more other playback devices to create a multi-channel audio environment. Numerous other example functions are possible, some of which are discussed below.
[0052] As just mentioned, certain functions may involve the playback device 102 synchronizing playback of audio content with one or more other playback devices. During synchronous playback, a listener may not perceive time-delay differences between playback of the audio content by the synchronized playback devices. U.S. Patent No. 8,234,395 filed on April 4, 2004, and titled “System and method for synchronizing operations among a plurality of independently clocked digital data processing devices,” which is hereby incorporated by reference in its entirety, provides in more detail some examples for audio playback synchronization among playback devices.
[0053] To facilitate audio playback, the playback device 102 includes audio processing components 216 that are generally configured to process audio prior to the playback device 102 rendering the audio. In this respect, the audio processing components 216 may include one or more digital-to-analog converters (“DAC”), one or more audio preprocessing components, one or more audio enhancement components, one or more digital signal processors (“DSPs”), and so on. In some implementations, one or more of the audio processing components 216 may be a subcomponent of the processor 212. In operation, the audio processing components 216 receive analog and/or digital audio and process and/or otherwise intentionally alter the audio to produce audio signals for playback.
[0054] The produced audio signals may then be provided to one or more audio amplifiers 217 for amplification and playback through one or more speakers 218 operably coupled to the amplifiers 217. The audio amplifiers 217 may include components configured to amplify audio signals to a level for driving one or more of the speakers 218.
[0055] In another aspect, the software code 214 configures the playback device 102 to be operable in a plurality of non contemporary room sound modes. In each mode, the playback device 102 may adopt certain settings and/or configurations in accordance with the room sound mode. Further, the software code 214 may be configured to detect occurrence of various triggers corresponding to one of more of the room sounds, and responsively switch the first playback
12
device from operating in one mode to operating in another mode. Further details related to the room sound modes are described in connection with section III below.
[0056] Each of the speakers 218 may include an individual transducer (e.g., a “driver”) or the speakers 218 may include a complete speaker system involving an enclosure with one or more drivers. A particular driver of a speaker 218 may include, for example, a subwoofer (e.g., for low frequencies), a mid-range driver (e.g., for middle frequencies), and/or a tweeter (e.g., for high frequencies). In some cases, a transducer may be driven by an individual corresponding audio amplifier of the audio amplifiers 217. In some implementations, a playback device may not include the speakers 218, but instead may include a speaker interface for connecting the playback device to external speakers. In certain embodiments, a playback device may include neither the speakers 218 nor the audio amplifiers 217, but instead may include an audio interface (not shown) for connecting the playback device to an external audio amplifier or audio-visual receiver.
[0057] In addition to producing audio signals for playback by the playback device 102, the audio processing components 216 may be configured to process audio to be sent to one or more other playback devices, via the network interface 224, for playback. In example scenarios, audio content to be processed and/or played back by the playback device 102 may be received from an external source, such as via an audio line-in interface (e.g., an auto-detecting 3.5mm audio line- in connection) of the playback device 102 (not shown) or via the network interface 224, as described below.
[0058] As shown, the at least one network interface 224, may take the form of one or more wireless interfaces 225 and/or one or more wired interfaces 226. A wireless interface may provide network interface functions for the playback device 102 to wirelessly communicate with other devices (e.g., other playback device(s), NMD(s), and/or controller device(s)) in accordance with a communication protocol (e.g., any wireless standard including IEEE 802.11a, 802.1 lb, 802.1 lg, 802.11h, 802.1 lac, 802.15, 4G mobile communication standard, and so on). A wired interface may provide network interface functions for the playback device 102 to communicate over a wired connection with other devices in accordance with a communication protocol (e.g., IEEE 802.3). While the network interface 224 shown in Figure 2 A include both wired and wireless interfaces, the playback device 102 may in some implementations include only wireless interface(s) or only wired interface(s).
[0059] In general, the network interface 224 facilitates data flow between the playback device 102 and one or more other devices on a data network. For instance, the playback device
13
102 may be configured to receive audio content over the data network from one or more other playback devices, network devices within a LAN, and/or audio content sources over a WAN, such as the Internet. In one example, the audio content and other signals transmitted and received by the playback device 102 may be transmitted in the form of digital packet data comprising an Internet Protocol (IP)-based source address and IP-based destination addresses. In such a case, the network interface 224 may be configured to parse the digital packet data such that the data destined for the playback device 102 is properly received and processed by the playback device 102.
[0060] As shown in Figure 2A, the playback device 102 also includes voice processing components 220 that are operably coupled to one or more microphones 222. The microphones 222 are configured to detect sound (i.e., acoustic waves) in the environment of the playback device 102, which is then provided to the voice processing components 220. More specifically, each microphone 222 is configured to detect sound and convert the sound into a digital or analog signal representative of the detected sound, which can then cause the voice processing component 220 to perform various functions based on the detected sound, as described in greater detail below. In one implementation, the microphones 222 are arranged as an array of microphones (e.g., an array of six microphones). In some implementations, the playback device 102 includes more than six microphones (e.g., eight microphones or twelve microphones) or fewer than six microphones (e.g., four microphones, two microphones, or a single microphones).
[0061] In operation, the voice-processing components 220 are generally configured to detect and process sound received via the microphones 222, identify potential voice input in the detected sound, and extract detected-sound data to enable a VAS, such as the VAS 190 (Figure IB), to process voice input identified in the detected-sound data. The voice processing components 220 may include one or more analog-to-digital converters, an acoustic echo canceller (“AEC”), a spatial processor (e.g., one or more multi-channel Wiener filters, one or more other filters, and/or one or more beam former components), one or more buffers (e.g., one or more circular buffers), one or more wake-word engines, one or more voice extractors, and/or one or more speech processing components (e.g., components configured to recognize a voice of a particular user or a particular set of users associated with a household), among other example voice processing components. In example implementations, the voice processing components 220 may include or otherwise take the form of one or more DSPs or one or more modules of a DSP. In this respect, certain voice processing components 220 may be configured with particular parameters (e.g., gain and/or spectral parameters) that may be modified or otherwise tuned to achieve particular
14
functions. In some implementations, one or more of the voice processing components 220 may be a subcomponent of the processor 212.
[0062] As further shown in Figure 2A, the playback device 102 also includes power components 227. The power components 227 include at least an external power source interface 228, which may be coupled to a power source (not shown) via a power cable or the like that physically connects the playback device 102 to an electrical outlet or some other external power source. Other power components may include, for example, transformers, converters, and like components configured to format electrical power.
[0063] In some implementations, the power components 227 of the playback device 102 may additionally include an internal power source 229 (e.g., one or more batteries) configured to power the playback device 102 without a physical connection to an external power source. When equipped with the internal power source 229, the playback device 102 may operate independent of an external power source. In some such implementations, the external power source interface 228 may be configured to facilitate charging the internal power source 229. As discussed before, a playback device comprising an internal power source may be referred to herein as a “portable playback device.” On the other hand, a playback device that operates using an external power source may be referred to herein as a “stationary playback device,” although such a device may in fact be moved around a home or other environment.
[0064] The playback device 102 further includes a user interface 240 that may facilitate user interactions independent of or in conjunction with user interactions facilitated by one or more of the controller devices 104. In various embodiments, the user interface 240 includes one or more physical buttons and/or supports graphical interfaces provided on touch sensitive screen(s) and/or surface(s), among other possibilities, for a user to directly provide input. The user interface 240 may further include one or more of lights (e.g., LEDs) and the speakers to provide visual and/or audio feedback to a user.
[0065] As an illustrative example, Figure 2B shows an example housing 230 of the playback device 102 that includes a user interface in the form of a control area 232 at a top portion 234 of the housing 230. The control area 232 includes buttons 236a-c for controlling audio playback, volume level, and other functions. The control area 232 also includes a button 236d for toggling the microphones 222 to either an on state or an off state.
[0066] As further shown in Figure 2B, the control area 232 is at least partially surrounded by apertures formed in the top portion 234 of the housing 230 through which the microphones 222
15
(not visible in Figure 2B) receive the sound in the environment of the playback device 102. The microphones 222 may be arranged in various positions along and/or within the top portion 234 or other areas of the housing 230 so as to detect sound from one or more directions relative to the playback device 102.
[0067] By way of illustration, SONOS, Inc. presently offers (or has offered) for sale certain playback devices that may implement certain of the embodiments disclosed herein, including a “PLAY:1,” “PLAY: 3,” “PLAY:5,” “PLAYBAR,” “CONNECT: AMP,” “PLAYBASE,” “BEAM,” “CONNECT,” and “SUB.” Any other past, present, and/or future playback devices may additionally or alternatively be used to implement the playback devices of example embodiments disclosed herein. Additionally, it should be understood that a playback device is not limited to the examples illustrated in Figures 2A or 2B or to the SONOS product offerings. For example, a playback device may include, or otherwise take the form of, a wired or wireless headphone set, which may operate as a part of the MPS 100 via a network interface or the like. In another example, a playback device may include or interact with a docking station for personal mobile media playback devices. In yet another example, a playback device may be integral to another device or component such as a television, a lighting fixture, or some other device for indoor or outdoor use.
[0068] Figure 2C is a diagram of an example voice input 280 that may be processed by an NMD or an NMD-equipped playback device. The voice input 280 may include a keyword portion 280a and an utterance portion 280b. The keyword portion 280a may include a wake word or a command keyword. In the case of a wake word, the keyword portion 280a corresponds to detected sound that caused a wake-word The utterance portion 280b corresponds to detected sound that potentially comprises a user request following the keyword portion 280a. An utterance portion 280b can be processed to identify the presence of any words in detected-sound data by the NMD in response to the event caused by the keyword portion 280a. In various implementations, an underlying intent can be determined based on the words in the utterance portion 280b. In certain implementations, an underlying intent can also be based or at least partially based on certain words in the keyword portion 280a, such as when keyword portion includes a command keyword. In any case, the words may correspond to one or more commands, as well as a certain command and certain keywords. A keyword in the voice utterance portion 280b may be, for example, a word identifying a particular device or group in the MPS 100. For instance, in the illustrated example, the keywords in the voice utterance portion 280b may be one or more words identifying one or more zones in which the music is to be played, such as the Living Room and the Dining Room (Figure 1A). In some cases, the utterance portion 280b may include additional information, such
16
as detected pauses (e.g., periods of non-speech) between words spoken by a user, as shown in Figure 2C. The pauses may demarcate the locations of separate commands, keywords, or other information spoke by the user within the utterance portion 280b.
[0069] Based on certain command criteria, the NMD and/or a remote VAS may take actions as a result of identifying one or more commands in the voice input. Command criteria may be based on the inclusion of certain keywords within the voice input, among other possibilities. Additionally, or alternatively, command criteria for commands may involve identification of one or more control-state and/or zone-state variables in conjunction with identification of one or more particular commands. Control-state variables may include, for example, indicators identifying a level of volume, a queue associated with one or more devices, and playback state, such as whether devices are playing a queue, paused, etc. Zone-state variables may include, for example, indicators identifying which, if any, zone players are grouped.
[0070] In some implementations, the MPS 100 is configured to temporarily reduce the volume of audio content that it is playing upon detecting a certain keyword, such as a wake word, in the keyword portion 280a. The MPS 100 may restore the volume after processing the voice input 280. Such a process can be referred to as ducking, examples of which are disclosed in U.S. Patent Application No. 15/438,749, incorporated by reference herein in its entirety.
[0071] Figure 2D shows an example sound specimen. In this example, the sound specimen corresponds to the sound-data stream (e.g., one or more audio frames) associated with a spotted wake word or command keyword in the keyword portion 280a of Figure 2A. As illustrated, the example sound specimen comprises sound detected in an NMD’s environment (i) immediately before a wake or command word was spoken, which may be referred to as a pre-roll portion (between times to and ti), (ii) while a wake or command word was spoken, which may be referred to as a wake-meter portion (between times ti and t2), and/or (iii) after the wake or command word was spoken, which may be referred to as a post-roll portion (between times t2 and t3). Other sound specimens are also possible. In various implementations, aspects of the sound specimen can be evaluated according to an acoustic model which aims to map mels/spectral features to phonemes in a given language model for further processing. For example, automatic speech recognition (ASR) may include such mapping for command-keyword detection. Wake-word detection engines, by contrast, may be precisely tuned to identify a specific wake-word, and a downstream action of invoking a VAS (e.g., by targeting only nonce words in the voice input processed by the playback device).
17
[0072] ASR for command keyword detection may be tuned to accommodate a wide range of keywords (e.g., 5, 10, 100, 1,000, 10,000 keywords). Command keyword detection, in contrast to wake-word detection, may involve feeding ASR output to an onboard, local NLU which together with the ASR determine when command word events have occurred. In some implementations described below, the local NLU may determine an intent based on one or more other keywords in the ASR output produced by a particular voice input. In these or other implementations, a playback device may act on a detected command keyword event only when the playback devices determines that certain conditions have been met, such as environmental conditions (e.g., low background noise).
[0073] The playback device 102 may further include a voice activity detector (VAD), which may be implemented as part of the voice processing components 220. The VAD is configured to detect the presence (or lack thereol) of voice activity in the sound-data stream from the microphones 222. In particular, the VAD may analyze frames corresponding to the pre-roll portion of the voice input 280a (Figure 2D) with one or more voice detection algorithms to determine whether voice activity was present in the environment in certain time windows prior to a keyword portion of the voice input 280a.
[0074] The VAD may utilize any suitable voice activity detection algorithms. Example voice detection algorithms involve determining whether a given frame includes one or more features or qualities that correspond to voice activity, and further determining whether those features or qualities diverge from noise to a given extent (e.g., if a value exceeds a threshold for a given frame). Some example voice detection algorithms involve filtering or otherwise reducing noise in the frames prior to identifying the features or qualities.
[0075] In some examples, the VAD may determine whether voice activity is present in the environment based on one or more metrics. For example, the VAD can be configured to distinguish between frames that include voice activity and frames that don't include voice activity. The frames that the VAD determines have voice activity may be caused by speech regardless of whether it near- or far-field. In this example and others, the VAD may determine a count of frames in the voice input 280a that indicate voice activity. If this count exceeds a threshold percentage or number of frames, the VAD may be configured to output a signal or set a state variable indicating that voice activity is present in the environment. Other metrics may be used as well in addition to, or as an alternative to, such a count.
18
[0076] When the VAD detects voice activity in an environment, the VAD may set a state variable in the playback device indicating that voice activity is present. Conversely, when the VAD does not voice activity in an environment, the VAD may set the state variable in the playback device to indicate that voice activity is not present. Changing the state of this state variable may function as a mode trigger condition in some examples. b. Example Playback Device Configurations
[0077] Figures 3A-3E show example configurations of playback devices. Referring first to Figure 3 A, in some example instances, a single playback device may belong to a zone. For example, the playback device 102c (Figure 1A) on the Patio may belong to Zone A. In some implementations described below, multiple playback devices may be “bonded” to form a “bonded pair,” which together form a single zone. For example, the playback device 102f (Figure 1A) named “Bed 1” in Figure 3 A may be bonded to the playback device 102g (Figure 1 A) named “Bed 2” in Figure 3A to form Zone B. Bonded playback devices may have different playback responsibilities (e.g., channel responsibilities). In another implementation described below, multiple playback devices may be merged to form a single zone. For example, the playback device 102d named “Bookcase” may be merged with the playback device 102m named “Living Room” to form a single Zone C. The merged playback devices 102d and 102m may not be specifically assigned different playback responsibilities. That is, the merged playback devices 102d and 102m may, aside from playing audio content in synchrony, each play audio content as they would if they were not merged.
[0078] For purposes of control, each zone in the MPS 100 may be represented as a single user interface (“UI”) entity. For example, as displayed by the controller devices 104, Zone A may be provided as a single entity named “Portable,” Zone B may be provided as a single entity named “Stereo,” and Zone C may be provided as a single entity named “Living Room.”
[0079] In various embodiments, a zone may take on the name of one of the playback devices belonging to the zone. For example, Zone C may take on the name of the Living Room device 102m (as shown). In another example, Zone C may instead take on the name of the Bookcase device 102d. In a further example, Zone C may take on a name that is some combination of the Bookcase device 102d and Living Room device 102m. The name that is chosen may be selected by a user via inputs at a controller device 104. In some embodiments, a zone may be given a name that is different than the device(s) belonging to the zone. For example, Zone B in Figure 3 A is named “Stereo” but none of the devices in Zone B have this name. In one aspect, Zone B is a
19
single UI entity representing a single device named “Stereo,” composed of constituent devices “Bed 1” and “Bed 2.” In one implementation, the Bed 1 device may be playback device 102f in the master bedroom 101b (Figure 1 A) and the Bed 2 device may be the playback device 102g also in the master bedroom 101b (Figure 1 A).
[0080] As noted above, playback devices that are bonded may have different playback responsibilities, such as playback responsibilities for certain audio channels. For example, as shown in Figure 3B, the Bed 1 and Bed 2 devices 102f and 102g may be bonded so as to produce or enhance a stereo effect of audio content. In this example, the Bed 1 playback device 102f may be configured to play a left channel audio component, while the Bed 2 playback device 102g may be configured to play a right channel audio component. In some implementations, such stereo bonding may be referred to as “pairing.”
[0081] Additionally, playback devices that are configured to be bonded may have additional and/or different respective speaker drivers. As shown in Figure 3C, the playback device 102b named “Front” may be bonded with the playback device 102k named “SUB.” The Front device 102b may render a range of mid to high frequencies, and the SUB device 102k may render low frequencies as, for example, a subwoofer. When unbonded, the Front device 102b may be configured to render a full range of frequencies. As another example, Figure 3D shows the Front and SUB devices 102b and 102k further bonded with Right and Left playback devices 102a and 102j, respectively. In some implementations, the Right and Left devices 102a and 102j may form surround or “satellite” channels of a home theater system. The bonded playback devices 102a, 102b, 102j, and 102k may form a single Zone D (Figure 3A).
[0082] In some implementations, playback devices may also be “merged.” In contrast to certain bonded playback devices, playback devices that are merged may not have assigned playback responsibilities, but may each render the full range of audio content that each respective playback device is capable of. Nevertheless, merged devices may be represented as a single UI entity (i.e., a zone, as discussed above). For instance, Figure 3E shows the playback devices 102d and 102m in the Living Room merged, which would result in these devices being represented by the single UI entity of Zone C. In one embodiment, the playback devices 102d and 102m may playback audio in synchrony, during which each outputs the full range of audio content that each respective playback device 102d and 102m is capable of rendering.
[0083] In some embodiments, a stand-alone NMD may be in a zone by itself. For example, the NMD 103h from Figure 1A is named “Closet” and forms Zone I in Figure 3A. An NMD may
20
also be bonded or merged with another device so as to form a zone. For example, the NMD device 103f named “Island” may be bonded with the playback device 102i Kitchen, which together form Zone F, which is also named “Kitchen.” Additional details regarding assigning NMDs and playback devices as designated or default devices may be found, for example, in previously referenced U.S. Patent Application No. 15/438,749. In some embodiments, a stand-alone NMD may not be assigned to a zone.
[0084] Zones of individual, bonded, and/or merged devices may be arranged to form a set of playback devices that playback audio in synchrony. Such a set of playback devices may be referred to as a “group,” “zone group,” “synchrony group,” or “playback group.” In response to inputs provided via a controller device 104, playback devices may be dynamically grouped and ungrouped to form new or different groups that synchronously play back audio content. For example, referring to Figure 3A, Zone A may be grouped with Zone B to form a zone group that includes the playback devices of the two zones. As another example, Zone A may be grouped with one or more other Zones C-I. The Zones A-I may be grouped and ungrouped in numerous ways. For example, three, four, five, or more (e.g., all) of the Zones A-I may be grouped. When grouped, the zones of individual and/or bonded playback devices may play back audio in synchrony with one another, as described in previously referenced U.S. Patent No. 8,234,395. Grouped and bonded devices are example types of associations between portable and stationary playback devices that may be caused in response to a trigger event, as discussed above and described in greater detail below.
[0085] In various implementations, the zones in an environment may be assigned a particular name, which may be the default name of a zone within a zone group or a combination of the names of the zones within a zone group, such as “Dining Room + Kitchen,” as shown in Figure 3A. In some embodiments, a zone group may be given a unique name selected by a user, such as “Nick’s Room,” as also shown in Figure 3A. The name “Nick’s Room” may be a name chosen by a user over a prior name for the zone group, such as the room name “Master Bedroom.”
[0086] Referring back to Figure 2A, certain data may be stored in the memory 213 as one or more state variables that are periodically updated and used to describe the state of a playback zone, the playback device(s), and/or a zone group associated therewith. The memory 213 may also include the data associated with the state of the other devices of the MPS 100, which may be shared from time to time among the devices so that one or more of the devices have the most recent data associated with the system.
21
[0087] In some embodiments, the memory 213 of the playback device 102 may store instances of various variable types associated with the states. Variables instances may be stored with identifiers (e.g., tags) corresponding to type. For example, certain identifiers may be a first type “al” to identify playback device(s) of a zone, a second type “bl” to identify playback device(s) that may be bonded in the zone, and a third type “cl” to identify a zone group to which the zone may belong. As a related example, in Figure 1A, identifiers associated with the Patio may indicate that the Patio is the only playback device of a particular zone and not in a zone group. Identifiers associated with the Living Room may indicate that the Living Room is not grouped with other zones but includes bonded playback devices 102a, 102b, 102j, and 102k. Identifiers associated with the Dining Room may indicate that the Dining Room is part of Dining Room + Kitchen group and that devices 103f and 102i are bonded. Identifiers associated with the Kitchen may indicate the same or similar information by virtue of the Kitchen being part of the Dining Room + Kitchen zone group. Other example zone variables and identifiers are described below.
[0088] In yet another example, the MPS 100 may include variables or identifiers representing other associations of zones and zone groups, such as identifiers associated with Areas, as shown in Figure 3A. An Area may involve a cluster of zone groups and/or zones not within a zone group. For instance, Figure 3A shows a first area named “First Area” and a second area named “Second Area.” The First Area includes zones and zone groups of the Patio, Den, Dining Room, Kitchen, and Bathroom. The Second Area includes zones and zone groups of the Bathroom, Nick’s Room, Bedroom, and Living Room. In one aspect, an Area may be used to invoke a cluster of zone groups and/or zones that share one or more zones and/or zone groups of another cluster. In this respect, such an Area differs from a zone group, which does not share a zone with another zone group. Further examples of techniques for implementing Areas may be found, for example, in U.S. Application No. 15/682,506 filed August 21, 2017 and titled “Room Association Based on Name,” and U.S. Patent No. 8,483,853 filed September 11, 2007, and titled “Controlling and manipulating groupings in a multi -zone media system.” Each of these applications is incorporated herein by reference in its entirety.
[0089] The memory 213 may be further configured to store other data. Such data may pertain to audio sources accessible by the playback device 102 or a playback queue that the playback device (or some other playback device(s)) may be associated with. In embodiments described below, the memory 213 is configured to store a set of command data for selecting a particular VAS when processing voice inputs. During operation, one or more playback zones in the environment of Figure 1A may each be playing different audio content. For instance, the user
22
may be grilling in the Patio zone and listening to hip hop music being played by the playback device 102c, while another user may be preparing food in the Kitchen zone and listening to classical music being played by the playback device 102i. In another example, a playback zone may play the same audio content in synchrony with another playback zone.
[0090] For instance, the user may be in the Office zone where the playback device 102n is playing the same hip-hop music that is being playing by playback device 102c in the Patio zone. In such a case, playback devices 102c and 102n may be playing the hip-hop in synchrony such that the user may seamlessly (or at least substantially seamlessly) enjoy the audio content that is being played out-loud while moving between different playback zones. Synchronization among playback zones may be achieved in a manner similar to that of synchronization among playback devices, as described in previously referenced U.S. Patent No. 8,234,395.
[0091] As suggested above, the zone configurations of the MPS 100 may be dynamically modified. As such, the MPS 100 may support numerous configurations. For example, if a user physically moves one or more playback devices to or from a zone, the MPS 100 may be reconfigured to accommodate the change(s). For instance, if the user physically moves the playback device 102c from the Patio zone to the Office zone, the Office zone may now include both the playback devices 102c and 102n. In some cases, the user may pair or group the moved playback device 102c with the Office zone and/or rename the players in the Office zone using, for example, one of the controller devices 104 and/or voice input. As another example, if one or more playback devices 102 are moved to a particular space in the home environment that is not already a playback zone, the moved playback device(s) may be renamed or associated with a playback zone for the particular space.
[0092] Further, different playback zones of the MPS 100 may be dynamically combined into zone groups or split up into individual playback zones. For example, the Dining Room zone and the Kitchen zone may be combined into a zone group for a dinner party such that playback devices 102i and 1021 may render audio content in synchrony. As another example, bonded playback devices in the Den zone may be split into (i) a television zone and (ii) a separate listening zone. The television zone may include the Front playback device 102b. The listening zone may include the Right, Left, and SUB playback devices 102a, 102j, and 102k, which may be grouped, paired, or merged, as described above. Splitting the Den zone in such a manner may allow one user to listen to music in the listening zone in one area of the living room space, and another user to watch the television in another area of the living room space. In a related example, a user may utilize
23
either of the NMD 103a or 103b (Figure IB) to control the Den zone before it is separated into the television zone and the listening zone. Once separated, the listening zone may be controlled, for example, by a user in the vicinity of the NMD 103a, and the television zone may be controlled, for example, by a user in the vicinity of the NMD 103b. As described above, however, any of the NMDs 103 may be configured to control the various playback and other devices of the MPS 100. c. Example Controller Devices
[0093] Figure 4 is a functional block diagram illustrating certain aspects of a selected one of the controller devices 104 of the MPS 100 of Figure 1A. Such controller devices may also be referred to herein as a “control device” or “controller.” The controller device shown in Figure 4 may include components that are generally similar to certain components of the network devices described above, such as a processor 412, memory 413 storing program software 414, at least one network interface 424, and one or more microphones 422. In one example, a controller device may be a dedicated controller for the MPS 100. In another example, a controller device may be a network device on which media playback system controller application software may be installed, such as for example, an iPhone™, iPad™ or any other smart phone, tablet, or network device (e.g., a networked computer such as a PC or Mac™).
[0094] The memory 413 of the controller device 104 may be configured to store controller application software and other data associated with the MPS 100 and/or a user of the system 100. The memory 413 may be loaded with instructions in software 414 that are executable by the processor 412 to achieve certain functions, such as facilitating user access, control, and/or configuration of the MPS 100. The controller device 104 is configured to communicate with other network devices via the network interface 424, which may take the form of a wireless interface, as described above.
[0095] In one example, system information (e.g., such as a state variable) may be communicated between the controller device 104 and other devices via the network interface 424. For instance, the controller device 104 may receive playback zone and zone group configurations in the MPS 100 from a playback device, an NMD, or another network device. Likewise, the controller device 104 may transmit such system information to a playback device or another network device via the network interface 424. In some cases, the other network device may be another controller device.
[0096] The controller device 104 may also communicate playback device control commands, such as volume control and audio playback control, to a playback device via the
24
network interface 424. As suggested above, changes to configurations of the MPS 100 may also be performed by a user using the controller device 104. The configuration changes may include adding/removing one or more playback devices to/from a zone, adding/removing one or more zones to/from a zone group, forming a bonded or merged player, separating one or more playback devices from a bonded or merged player, among others.
[0097] As shown in Figure 4, the controller device 104 also includes a user interface 440 that is generally configured to facilitate user access and control of the MPS 100. The user interface 440 may include a touch-screen display or other physical interface configured to provide various graphical controller interfaces, such as the controller interfaces 540a and 540b shown in Figures 5A and 5B. Referring to Figures 5A and 5B together, the controller interfaces 540a and 540b includes a playback control region 542, a playback zone region 543, a playback status region 544, a playback queue region 546, and a sources region 548. The user interface as shown is just one example of an interface that may be provided on a network device, such as the controller device shown in Figure 4, and accessed by users to control a media playback system, such as the MPS 100. Other user interfaces of varying formats, styles, and interactive sequences may alternatively be implemented on one or more network devices to provide comparable control access to a media playback system.
[0098] The playback control region 542 (Figure 5A) may include selectable icons (e.g., by way of touch or by using a cursor) that, when selected, cause playback devices in a selected playback zone or zone group to play or pause, fast forward, rewind, skip to next, skip to previous, enter/exit shuffle mode, enter/exit repeat mode, enter/exit cross fade mode, etc. The playback control region 542 may also include selectable icons that, when selected, modify equalization settings and/or playback volume, among other possibilities.
[0099] The playback zone region 543 (Figure 5B) may include representations of playback zones within the MPS 100. The playback zones regions 543 may also include a representation of zone groups, such as the Dining Room + Kitchen zone group, as shown.
[0100] In some embodiments, the graphical representations of playback zones may be selectable to bring up additional selectable icons to manage or configure the playback zones in the MPS 100, such as a creation of bonded zones, creation of zone groups, separation of zone groups, and renaming of zone groups, among other possibilities.
25
[0101] For example, as shown, a “group” icon may be provided within each of the graphical representations of playback zones. The “group” icon provided within a graphical representation of a particular zone may be selectable to bring up options to select one or more other zones in the MPS 100 to be grouped with the particular zone. Once grouped, playback devices in the zones that have been grouped with the particular zone will be configured to play audio content in synchrony with the playback device(s) in the particular zone. Analogously, a “group” icon may be provided within a graphical representation of a zone group. In this case, the “group” icon may be selectable to bring up options to deselect one or more zones in the zone group to be removed from the zone group. Other interactions and implementations for grouping and ungrouping zones via a user interface are also possible. The representations of playback zones in the playback zone region 543 (Figure 5B) may be dynamically updated as playback zone or zone group configurations are modified.
[0102] The playback status region 544 (Figure 5A) may include graphical representations of audio content that is presently being played, previously played, or scheduled to play next in the selected playback zone or zone group. The selected playback zone or zone group may be visually distinguished on a controller interface, such as within the playback zone region 543 and/or the playback status region 544. The graphical representations may include track title, artist name, album name, album year, track length, and/or other relevant information that may be useful for the user to know when controlling the MPS 100 via a controller interface.
[0103] The playback queue region 546 may include graphical representations of audio content in a playback queue associated with the selected playback zone or zone group. In some embodiments, each playback zone or zone group may be associated with a playback queue comprising information corresponding to zero or more audio items for playback by the playback zone or zone group. For instance, each audio item in the playback queue may comprise a uniform resource identifier (URI), a uniform resource locator (URL), or some other identifier that may be used by a playback device in the playback zone or zone group to find and/or retrieve the audio item from a local audio content source or a networked audio content source, which may then be played back by the playback device.
[0104] In one example, a playlist may be added to a playback queue, in which case information corresponding to each audio item in the playlist may be added to the playback queue. In another example, audio items in a playback queue may be saved as a playlist. In a further example, a playback queue may be empty, or populated but “not in use” when the playback zone
26
or zone group is playing continuously streamed audio content, such as Internet radio that may continue to play until otherwise stopped, rather than discrete audio items that have playback durations. In an alternative embodiment, a playback queue can include Internet radio and/or other streaming audio content items and be “in use” when the playback zone or zone group is playing those items. Other examples are also possible.
[0105] When playback zones or zone groups are “grouped” or “ungrouped,” playback queues associated with the affected playback zones or zone groups may be cleared or re associated. For example, if a first playback zone including a first playback queue is grouped with a second playback zone including a second playback queue, the established zone group may have an associated playback queue that is initially empty, that contains audio items from the first playback queue (such as if the second playback zone was added to the first playback zone), that contains audio items from the second playback queue (such as if the first playback zone was added to the second playback zone), or a combination of audio items from both the first and second playback queues. Subsequently, if the established zone group is ungrouped, the resulting first playback zone may be re-associated with the previous first playback queue or may be associated with a new playback queue that is empty or contains audio items from the playback queue associated with the established zone group before the established zone group was ungrouped. Similarly, the resulting second playback zone may be re-associated with the previous second playback queue or may be associated with a new playback queue that is empty or contains audio items from the playback queue associated with the established zone group before the established zone group was ungrouped. Other examples are also possible.
[0106] With reference still to Figures 5A and 5B, the graphical representations of audio content in the playback queue region 646 (Figure 5A) may include track titles, artist names, track lengths, and/or other relevant information associated with the audio content in the playback queue. In one example, graphical representations of audio content may be selectable to bring up additional selectable icons to manage and/or manipulate the playback queue and/or audio content represented in the playback queue. For instance, a represented audio content may be removed from the playback queue, moved to a different position within the playback queue, or selected to be played immediately, or after any currently playing audio content, among other possibilities. A playback queue associated with a playback zone or zone group may be stored in a memory on one or more playback devices in the playback zone or zone group, on a playback device that is not in the playback zone or zone group, and/or some other designated device. Playback of such a playback
27
queue may involve one or more playback devices playing back media items of the queue, perhaps in sequential or random order.
[0107] The sources region 548 may include graphical representations of selectable audio content sources and/or selectable voice assistants associated with a corresponding VAS. The VASes may be selectively assigned. In some examples, multiple VASes, such as AMAZON’S Alexa, MICROSOFT’S Cortana, etc., may be invokable by the same NMD. In some embodiments, a user may assign a VAS exclusively to one or more NMDs. For example, a user may assign a first VAS to one or both of the NMDs 102a and 102b in the Living Room shown in Figure 1A, and a second VAS to the NMD 103f in the Kitchen. Other examples are possible. d. Example Audio Content Sources
[0108] The audio sources in the sources region 548 may be audio content sources from which audio content may be retrieved and played by the selected playback zone or zone group. One or more playback devices in a zone or zone group may be configured to retrieve for playback audio content (e.g., according to a corresponding URI or URL for the audio content) from a variety of available audio content sources. In one example, audio content may be retrieved by a playback device directly from a corresponding audio content source (e.g., via a line-in connection). In another example, audio content may be provided to a playback device over a network via one or more other playback devices or network devices. As described in greater detail below, in some embodiments audio content may be provided by one or more media content services.
[0109] Example audio content sources may include a memory of one or more playback devices in a media playback system such as the MPS 100 of Figure 1, local music libraries on one or more network devices (e.g., a controller device, a network-enabled personal computer, or a networked-attached storage (“NAS”)), streaming audio services providing audio content via the Internet (e.g., cloud-based music services), or audio sources connected to the media playback system via a line-in input connection on a playback device or network device, among other possibilities.
[0110] In some embodiments, audio content sources may be added or removed from a media playback system such as the MPS 100 of Figure 1A. In one example, an indexing of audio items may be performed whenever one or more audio content sources are added, removed, or updated. Indexing of audio items may involve scanning for identifiable audio items in all folders/directories shared over a network accessible by playback devices in the media playback system and generating or updating an audio content database comprising metadata (e.g., title, artist, album,
28
track length, among others) and other associated information, such as a URI or URL for each identifiable audio item found. Other examples for managing and maintaining audio content sources may also be possible.
[0111] Figure 6 is a message flow diagram illustrating data exchanges between devices of the MPS 100. At step 650a, the MPS 100 receives an indication of selected media content (e.g., one or more songs, albums, playlists, podcasts, videos, stations) via the control device 104. The selected media content can comprise, for example, media items stored locally on or more devices (e.g., the audio source 105 of Figure 1C) connected to the media playback system and/or media items stored on one or more media service servers (one or more of the remote computing devices 106 of Figure IB). In response to receiving the indication of the selected media content, the control device 104 transmits a message 651a to the playback device 102 (Figures 1A-1C) to add the selected media content to a playback queue on the playback device 102.
[0112] At step 650b, the playback device 102 receives the message 651a and adds the selected media content to the playback queue for play back.
[0113] At step 650c, the control device 104 receives input corresponding to a command to play back the selected media content. In response to receiving the input corresponding to the command to play back the selected media content, the control device 104 transmits a message 651b to the playback device 102 causing the playback device 102 to play back the selected media content. In response to receiving the message 651b, the playback device 102 transmits a message 651c to the computing device 106 requesting the selected media content. The computing device 106, in response to receiving the message 651c, transmits a message 651d comprising data (e.g., audio data, video data, a URL, a URI) corresponding to the requested media content.
[0114] At step 650d, the playback device 102 receives the message 651d with the data corresponding to the requested media content and plays back the associated media content.
[0115] At step 650e, the playback device 102 optionally causes one or more other devices to play back the selected media content. In one example, the playback device 102 is one of a bonded zone of two or more players (Figure 1M). The playback device 102 can receive the selected media content and transmit all or a portion of the media content to other devices in the bonded zone. In another example, the playback device 102 is a coordinator of a group and is configured to transmit and receive timing information from one or more other devices in the group. The other one or more devices in the group can receive the selected media content from the computing device 106, and begin playback of the selected media content in response to a message
29
from the playback device 102 such that all of the devices in the group play back the selected media content in synchrony.
[0116] Within examples, such messages may conform to one or more protocols or interfaces (e.g., an Application Programming Interface). A platform API may support one or more namespaces that include controllable resources (e.g., the playback devices 102 and features thereof). Various functions may modify the resources and thereby control actions on the playback devices 102. For instance, HTTP request methods such as GET and POST may request and modify various resources in a namespace. Example namespaces in a platform API include playback (including controllable resources for playback), playbackMetadata (including metadata resources related to playback), volume (including resources for volume control), playlist (including resources for queue management), and groupVolume (including resources for volume control of a synchrony group), among other examples. Among other examples, such messages may conform to a standard, such as universal-plug-and-play (uPnP).
III. Example Authorization Management in a Media Playback System
[0117] Example techniques described herein relate to authorization management in a media playback system. Figure 7 is a functional block diagram illustrating an example architecture 700 to facilitate authorization management. The architecture 700 and its constituent devices is provided for purposes of illustration only, and other implementations may include different combinations of devices.
[0118] Shown in Figure 7 are one or more platform servers 706. The platform servers 706 may provide one or more platform services that support the media playback system 100. In providing cloud-based platform services, the one or more platform servers 706 may operate as a cloud-based hub for a plurality of media playback systems 100 (e.g., with unique household identifiers, which may be registered to different users and/or located in different households), as well as other types of “smart home” systems and platforms. Within examples, the platform servers 706 may be self-hosted, or hosted using a cloud service provider (e.g., Amazon Web Services®), or may be representative of third-party computing systems that provide cloud services.
[0119] The platform servers 706 are located in the "cloud." That is, they are not on the LAN 111 and are instead connected to the networks 107 (Figure IB). Other computing systems in the cloud include the computing devices 106a (which provide the voice assistant service 190) (Figure IB) and also the computing devices 106b (which provide the MCS 192).
30
[0120] As shown, the platform servers 706 may provide a first authentication service 706a (illustrated as an AuthN service 706a) and a second authentication service 706b (represented as an AuthZ service 706b). The AuthN service 706a is an identify authentication service that is configured to receive user credentials (e.g., a user name/password, a pin, scanned token, client SSL certificate, among other examples) from a client and, if such user credentials are valid, provide an authorization token (e.g., an OAuth token) in response. The AuthZ service 706b is a service that provides information on the role and permissions that a client with a particular identity (i.e., the token) should be allowed to access.
[0121] Figure 7 also shows examples of clients. In particular, a control device 104a is representative of an example of the control device 104 implemented using a mobile device and a media playback system control application (e.g., a first party control application). A control device 104b is representative of an example of the control device 104 implemented using a mobile device and a streaming audio service application (e.g., a third party streaming audio service application, such as a SPOTIFY ®, PANDORA®, or APPLE MUSIC® app). A third possible client is an NMD 103f. Each of these example clients are configurable to control at least some features on the playback devices 102a-n (Figure 1A).
[0122] For the purpose of illustration, Figure 7 shows the playback device 102n as including an edge data cache 760. As described in more detail in the following sections, certain authorization data, such as token-to-role mappings 761a and/or role-to-permissions mappings 761b, may be cached to reduce interaction with the cloud. That is, instead of querying the platform services 706, certain queries may be handled by data stored in the edge data cache 760. By reducing queries to the AuthN service 706a and AuthZ service 706B, certain hosting related costs may be reduced. For instance, some third party hosting services may charge by the number of I/O requests made and a lower number of requests will result in lower hosting costs.
[0123] Within examples, the edge data cache 760 may be stored in a portion of the memory 213. Yet further, in some examples, the edge data cache 760 may be maintain in random access memory (RAM) to avoid write cycles on persistent flash data storage. Since the playback devices 102 are seldom powered-off (instead entering a low-power state when not in use), the cache can be maintained in RAM for sufficiently long periods.
[0124] Figure 8A is a message flow diagram illustrating data exchanges between devices shown the architecture 700 to perform authorization of anew client (the control device 104a). The message flow diagram begins with authenticating a client. At 865a, the control device 104a sends
31
authentication credentials to the authentication service 706a. The authentication service 706a determines whether the authentication credentials are valid, and if so, sends a token to the control device 104a at 865b. This token is referred to in this example as a first token.
[0125] At 865c, the control device 104a sends a command to the playback device 102n. Example commands include various commands that direct the playback device to perform any of the example features described herein, as well as other features of playback devices. In an example, the commands may take the form of HTTP request methods such as GET and POST, which reference a resource in a namespace to get information about the resource or to set certain values of the resource. For instance, a POST request in a playback namespace may set a media item to play back.
[0126] Before performing a restricted action (e.g., via the command), the client authenticates with the playback device 102n. As shown in Figure 8A, the command includes the first token. The first token may be referenced in a header (e.g., an HTTP header) possibly along with other information to facilitate the command. This token may be used to authenticate the client with the playback device 102n.
[0127] After receiving such a command, the playback device 102n attempts to resolve the role(s). In particular, at 865d, the playback device 102n checks a token-to-role cache. For instance, the playback device 102n may determine whether the edge data cache 760 includes or excludes a token-to-role mapping corresponding to the first token (e.g., in the token-to-role mappings 761a) (Figure 7). Based on determining that the edge data cache 760 excludes a token-to-role mapping corresponding to the first token (i.e., a cache miss), the playback device 102n goes to the cloud to attempt to resolve the roles.
[0128] In particular, at 865e, the playback device 102n sends a request for a role corresponding to the first token to the authentication service 706b. As illustrated in Figure 8A, the request includes indications of the first token, the object (e.g., the media playback system 100, or the playback device 102n, depending on scope), and any modifiers. The request may take the form of a HTTP POST request with the indications carried in a header. An example POST request to resolve roles is shown as follows:
32
POST /authz/vl/role/resolve HTTP/1.1
"token": "OAUTH TOKEN",
"objectld": "012345ABCDEF", // serial number "objectType ": "player",
"attributes": { // attributes can be expanded "route": "lan", // lan|wan|bluetooth "openLanEnabled": true //
}
}
As shown, the HTTP header of the POST request includes an OAuth token, an objectID (indicating the serial number of the playback device 102n), an obj ectType (including that it’s a player, or playback device), as well as some attributes. As discussed in further detail below, such attributes may modify the permissions granted to a role.
[0129] At 865f, the authentication service 706b sends a request to validate the first token to the authentication service 706a. Then, at 865g, the authentication service 706a replies with a validation result. If the first token is valid, the validation result indicates that the first token is valid and also provides an indication of a first time-to-live period (denoted as "TTL1"). This first time- to-live period indicates how long the authentication token remains valid. After a time-to-live period expires, the associated cached data is considered stale and cannot be used to resolve roles.
[0130] When the validation result is successful, the authentication service 706b determines the token-to-role mapping for the first token. The authentication service 706b maintains or has access to token-to-role mappings for each token. The authentication service 706b may act as a "source of truth" for such mappings in the authentication system.
[0131] Such mappings may be created via a client having certain permissions (e.g., administrator or owner permissions) using a suitable user interface (e.g., the user interface 440 in Figure 4) in order to assign certain users and/or their respective client devices to specific roles within the media playback system 100. In some examples, some clients may be unknown or anonymous such that there is no mapping for that client. In such examples, the clients may be automatically assigned to a specific role (e.g., guest). Such clients may be latter elevated to a different role via the user interface.
[0132] Within examples, determining the token-to-role mapping for the first token may involve querying a database or other data storage structure for a role matching the object and the token. Such a query may return an indication of the role(s) corresponding to the token on the
33
object. An indication of such roles may be ultimately provided to the playback device 102n in a response.
[0133] In further examples, the role(s) may be modified based on one or more modifiers. One example of a modifier is the route of the client command. As illustrated above in the example POST request to resolve roles, example values of the route modifier include LAN, WAN, and Bluetooth. Commands arriving via the LAN and/or Bluetooth routes may be modified to a relatively higher role, as connection via such routes is generally more trustworthy than a WAN route (e.g., from a guest to an owner role). That is, a client on a secure LAN or a Bluetooth connection is more likely to be a trusted client than a client attempting to connect via the broader internet. In other examples, all three routes may modify the role differently. For instance, a LAN route may modify the role to a higher role, the Bluetooth route might not modify the role, and the WAN route may lower the role. Many examples of different modifications based on the routes are contemplated.
[0134] At 865h, the authentication service 706b sends a response to the playback device 102n. If the first token is valid, the response will indicate a success. An example successful response is shown as follows:
HTTP/1.1200 OK
Cache-Control: private,max-age=300,stale-whilerevalidate=
30,stale-if-error=300
ETag: 8ccsefca3640bf81alel0j2w72d98rbn Content-Type: application/json
{
"status": "OK",
"uid": "asdfghjkl", // okta user id "luid": "12345", // the legacy user id,
"apiKey": "DED3E12F-AE8A-45BC-BFB6-A91C80D87EC7 ",
"policyKey": "8dLS-STphqyG fezbJS83zK-7BU"
}
As shown, the response indicates "OK" as the "status" representing a successful response to the request to resolve roles. The HTTP header also includes a policyKey which indicates the role(s) corresponding to the first token. This role is referred to herein as a first role.
[0135] The HTTP header of the response also includes information to facilitate caching. In particular, the header indicates the first time-to-live period, which in this example is 300 seconds. The header also includes an entity tag (“ETag”) to identify the particular version of the resource (e.g., the policyKey). As explained in further detail below, the ETag may be used to determine
34
whether the policyKey has been changed (and thus needs to be re-requested from the authentication service 706b).
[0136] At 865i, the playback device 102n caches the token-to-role mapping in the edge data cache 760 (e.g., in the token-to-role mapping 761a). In some examples, the caching is maintained for the first time-to-live period and removed from the cache when this period expires. In other examples, the caching is considered valid for the first time-to-live period (and can't be used to resolve roles after invalidated as it is considered stale). In either case, the cached token-to-role mapping may be used to resolve roles for the first time-to-live period. As explained further below, certain requests may refresh the cache.
[0137] After resolving the role(s), the playback device 102n may next attempt to resolve permissions. At 865j, the playback device 102n checks a role-to-permission cache. For instance, the playback device 102n may determine whether the edge data cache 760 includes or excludes a role-to-permission mapping corresponding to the first token (e.g., in the role-to-permission mappings 761b) (Figure 7). Based on determining that the edge data cache 760 excludes a token- to-role mapping corresponding to the first role (i.e., a cache miss), the playback device 102n goes to the cloud to attempt to resolve the permissions.
[0138] In particular, at 865k, the playback device 102n sends a request to the authentication services 706b to resolve the permissions. As illustrated in Figure 8A, the request includes an indication of the first role. The request may take the form of a HTTP GET request. An example
GET request to resolve permissions is shown as follows:
GET /authz/vl/policy /8dLSSTphqyG_ fezbJS83zK- 7BU HTTP/1.1
As shown, the HTTP GET request includes the policyKey as an indication of the resolved role.
[0139] Within examples, determining the role-to-permission mapping for the first role may involve querying a database or other data storage structure for a permission set matching the role. Such a query may return an indication of the permission set corresponding to the role. An indication of such permissions may be ultimately provided to the playback device 102n in a response.
[0140] At 8651, the authentication service 706b sends a response to the request to resolve permissions. The response includes an indication of the permissions set corresponding to the first
35
role. In this example, the permissions set in in the form of a permissions mask. The response also includes an indication of a second time-to-live period (TTL2), which indicates how long the permissions mask for the first role remains valid. An example successful response is shown as follows:
HTTP/1.1200 OK
Cache-Control: public,max-age=86400,stale-while- revalidate=43200,stale-if-error=43200 ETag: 6ccceca3640bf81alel0135e3d286b8c Content-Type: application/json
{"namespace": "groupVolume ", "permissions": 3}, {"namespace": "playback", "permissions": 5}, {"namespace": "playbackMetadata ", "permissions": 1}, {"namespace": "volume", "permissions": 3},
{"namespace": "playlist", "permissions": 7},
/ / ...
]
As shown, the response includes a map of namespaces to permissions bitmasks. Here the integers in the mask represent permissions for different types of commands within a namespace, similar to a Unix permissions mask.
[0141] More particularly, a namespace may define a bit-position-to-permission order within the bitmask. For instance, a "playlist" namespace (including playlist resources) may define a bit- position-to-permission as "create," "read," "update," "delete" and "load" permissions corresponding to the least significant bit to the most significant bit, respectively. An HTTP example is as follows:
<muse-namespace name= "playlists "
<permission name= "CREATE "/>
<permission name= "READ"/>
<permission name="UPDATE"/>
<permission name="DELETE"/>
<permission name= "LOAD"/>
< !-- Most-significant bit --
>
</permissions>
</muse-namespace>
36
In this example, a permissions mask of "18" represents permissions to READ and LOAD, but not to CREATE, UPDATE, or DELETE. Such permission as represented as follows:
18 (dec) 10010 (bin)
0 (LSB) PLAYLIST::CREATE 1 PLAYLIST::READ 0 PLAYLIST::UPDATE 0 PLAYLIST::DELETE 1 (MSB) PLAYLIST::LOAD
As another example, a permissions mask of "31" (or "11111" in binary) in the "playlist" namespace represents permissions to CREATE, READ, UPDATE, DELETE, and LOAD, which would be representative of full (e.g., owner or administrator) permissions.
[0142] The HTTP header of the response also includes information to facilitate caching. In particular, the header indicates the second time-to-live period, which in this example is 86400 seconds. The header also includes an ETag to identify the particular version of the resource (e.g., the permissions mask). As explained in further detail below, the ETag may be used to determine whether the permissions mask has been changed (and thus needs to be re-requested from the authentication service 706b).
[0143] In some implementations, role resolution and permissions resolution are intentionally separated into separate requests, as they have different usage patterns and requirements. To facilitate quick revocation of access (e.g., of guests), a subject-to-role mapping may have a relatively short time-to-live in the edge data cache 760. In contrast, a role-to- permissions map is less likely to change frequently and so may be cached for a longer period. To illustrate, the example first time-to-live period for the token-to-role mapping is much shorter (300 seconds) than the example second time-to-live period for the role-to-permissions mapping (86400 seconds).
[0144] Each token-to-role mapping is unique to each client, whereas many clients may have the same role, which maps to the same permissions. As such, in certain usage scenarios, such as a house party, retail, or hospitality business, there may be many clients with unique tokens but the same role. As such, as unique guests come and go, the role-to-permissions mappings in the edge data cache 760 may be hit relatively more often (e.g,. for the same guest role) as compared with the token-to-role mappings. As such, in at least these usage patterns, caching role-to-permissions mappings may avoid relatively more server requests as compared with the token-to-role mappings. Some implementations might not utilize token-to-role mappings and instead rely only on role-to- permissions mappings as cache hits are less likely in the token-to-role mappings.
37
[0145] At 865m, the playback device 102n caches the role-to-permissions mapping in the edge data cache 760 (e.g., in the role-to-permissions mappings 761b). In some examples, the caching is maintained for the second time-to-live period and removed from the cache when this period expires. In other examples, the caching is considered valid for the second time-to-live period (and can't be used to resolve permissions after invalidated as it is considered stale). In either case, the cached role-to-permissions mapping may be used to resolve roles for the second time- to-live period. Like other cached data, some types of requests may refresh this cached data.
[0146] Once the playback device 102n has the permissions set, the playback device 102n may determine whether to accept or reject the command. That is, the playback device 102n may determine that the command is permitted by the resolved permission set and carry out the command at 865n. Conversely, the playback device 102n may determine that the command is prohibited by the resolved permission set and not carry out the command.
[0147] To illustrate, following the above example, when the command attempts to read or modify a resource in a given namespace (e.g., is a command to change volume in a "volume" namespace), the playback device 102n may determine whether the bitmask integer for that namespace in the permissions mask allows that client to modify volume on that object (i.e., the playback device 102n). If the command is permitted, the command is carried out.
[0148] When the playback device 102n is in a group (e.g., a zone group (Fig. 3E) or a bonded zone (Figs. 3A-3D), the command may operate on multiple playback devices (e.g., all playback devices in the group. For instance, a command modifying the "playback" namespace may change playback on all playback devices 102 in a group. However, some commands might operate individually. For instance, a command modifying the "volume" namespace may change volume an individual playback device 102 (as compared with a command modifying the "groupVolume" namespace, which may modify the volume of the group as a whole).
[0149] Within examples, at 865o, the playback device 102n may provide a command result to the control device 104a. The command result indicates whether the command was carried out and may also indicate current resource states following the command (which may be updated if the command modified the resource). For instance, if the volume resource was modified to a different volume level, the command result may indicate the new volume level.
[0150] When receiving the command result, the control device 104a may update a user interface (e.g., the control interfaces 540) to indicate the result of the command. For instance, if the command was carried out, a control corresponding to the corresponding resource (e.g., a
38
volume slider) may be updated to indicate the modified volume level. If the command was not carried out, an indication of this result may be explicitly indicated (e.g., by graying out or otherwise modifying an associated control, or an explicit message indicating that the user cannot perform this command).
[0151] Figure 8B is another message flow diagram illustrating data exchanges between devices shown the architecture 700. The message flow diagram of Figure 8B represents a message flow that may occur after a client is authenticated and mappings are cached in the edge data cache 760. Further, in this example, the control device 104a already has a valid token (e.g., the first token of the Figure 8A example).
[0152] At 866a, the control device 104a sends a command to the playback device 102n. Before performing a restricted action (e.g., via the command), the client authenticates with the playback device 102n. As shown in Figure 7A, the command includes the first token, which as noted above may be used to authenticate the client with the playback device 102n.
[0153] After receiving such a command, the playback device 102n attempts to resolve the role(s). In particular, at 866b, the playback device 102n checks a token-to-role cache. For instance, the playback device 102n may determine whether the edge data cache 760 includes or excludes a token-to-role mapping corresponding to the first token (e.g., in the token-to-role mappings 761a) (Figure 7). Based on determining that the edge data cache 760 includes a token-to-role mapping corresponding to the first token (i.e., a cache hit), the playback device 102n resolves the role using the cached token-to-role mapping. Continuing the Fig. 8A example, using the cached token-to- role mapping, the playback device 102n may resolve the first token to the first role (e.g., as indicated by the policyKey) resolved in the Fig. 8A example.
[0154] After resolving the roles, the playback device 102n attempts to resolve the permissions set corresponding to the first role. At 866c, the playback device 102n checks the role- to-permissions cache. For instance, the playback device 102n may determine whether the edge data cache 760 includes or excludes a role-to-permissions mapping corresponding to the first role (e.g., in the role-to-permissions mappings 761b) (Figure 7). Based on determining that the edge data cache 760 includes a role-to-permissions mapping corresponding to the first role (i.e., a cache hit), the playback device 102n resolves the permissions set using the cached role-to-permissions maping. Continuing the Fig. 8A example, using the cached token-to-role mapping, the playback device 102n may resolve the first role to the first permissions sest (e.g., as indicated by the permission mask) resolved in the Fig. 8A example.
39
[0155] Similar to the Figure 8A example, after resolving the permissions set, the playback device 102n may determine whether to accept or reject the command. That is, the playback device 102n may determine that the command is permitted by the resolved permission set and carry out the command at 866d. Conversely, the playback device 102n may determine that the command is prohibited by the resolved permission set and not carry out the command.
[0156] At 866e, the playback device 102n may provide a command result to the control device 104a. The command result indicates whether the command was carried out and may also indicate current resource states following the command (which may be updated if the command modified the resource). When receiving the command result, the control device 104a may update a user interface (e.g., the control interfaces 540) to indicate the result of the command.
[0157] In some cases, the edge data cache 760 includes a mapping but the cached data is stale. For instance, the role-to-permission cache may include a role-to-permission mapping corresponding to the first role, but the corresponding second time-to-live period is expired, thereby indicating that the cached data is stale. In such cases, the playback device 102n may send a conditional request (e.g., an HTTP request with an if-modified-since HTTP header) indicating the ETag of the cached role-to-permission mapping.
[0158] If the role-to-permission mapping has not changed (as indicated by the ETag of the cached role-to-permission mapping matching the ETag of the role-to-permission mapping at the authentication service 706b, the authentication service 706b can respond with a particular status (e.g., 200 status) indicating that the cached data is still the same. Here, the authentication service 706b does not have to send the body (including the permission mask) and instead sends only the header, thereby minimizing data transmission traffic and accordingly saving on data transmission costs.
[0159] To illustrate, Figure 8C is another message flow diagram illustrating data exchanges between devices shown in architecture 700 to perform authorization of another client (the control device 104b) (Figure 7). The message flow diagram begins with authenticating a client. At 867a, the control device 104b sends authentication credentials to the authentication service 706a. The authentication service 706a determines whether the authentication credentials are valid, and if so, sends a token to the control device 104b at 867b. This token is referred to in this example as a second token.
[0160] At 867c, the control device 104a sends a command to the playback device 102n. Before performing a restricted action (e.g., via the command), the client authenticates with the
40
playback device 102n. Here, the command includes the second token. Like the first token, the second token may be referenced in a header (e.g., an HTTP header) possibly along with other information to facilitate the command. This second token may be used to authenticate the second client with the playback device 102n.
[0161] After receiving such a command, the playback device 102n attempts to resolve the role(s). In particular, at 867d, the playback device 102n checks the token-to-role cache. For instance, the playback device 102n may determine whether the edge data cache 760 includes or excludes a token-to-role mapping corresponding to the second token (e.g., in the token-to-role mappings 761a) (Figure 7). Based on determining that the edge data cache 760 excludes a token- to-role mapping corresponding to the second token (i.e., a cache miss), the playback device 102n goes to the cloud to attempt to resolve the roles.
[0162] In particular, at 867e, the playback device 102n sends a request for a role corresponding to the second token to the authentication service 706b. As illustrated in Figure 8C, the request includes indications of the second token, the object (e.g., the media playback system 100, or the playback device 102n, depending on scope), and any modifications. The request may take the form of a HTTP POST request with the indications carried in a header.
[0163] At 867f, the authentication service 706b sends a request to validate the second token to the authentication service 706a. Then, at 867g, the authentication service 706a replies with a validation result. If the second token is valid, the validation result indicates that the second token is valid and also provides an indication of the first time-to-live period (denoted as "TTL1"). Note that this first time-to-live period may be the same duration as the first time-to-live period for the first token (or may be set differently, perhaps based on the type of client). For instance, a token for a client that has third-party software may be validated a different (e.g., shorter) time-to-live period.
[0164] When the validation result is successful, the authentication service 706b determines the token-to-role mapping for the second token. As explained above, the authentication service 706b maintains or has access to token-to-role mappings for each token. Within examples, determining the token-to-role mapping for the second token may involve querying a database or other data storage structure for a role matching the object and the second token. Such a query may return an indication of the role(s) corresponding to the second token on the object. An indication of such roles may be ultimately provided to the playback device 102n in a response.
41
[0165] At 867h, the authentication service 706b sends a response to the playback device 102n. If the second token is valid, the response will indicate a success and the resolved role mapping. In this example, the resolved role corresponding to the second token is referred to as a second role.
[0166] At 867i, the playback device 102n caches the token-to-role mapping in the edge data cache 760 (e.g., in the token-to-role mapping 761a). In some examples, the caching is considered stale after expiration of the first time-to-live period. If the cache is stale, the cached data cannot be used unless a conditional request to the authentication service 706b (e.g., an if-modified-since HTTP request) indicates that the cached data is still up-to-date.
[0167] After resolving the role(s), the playback device 102n next attempts to resolve permissions. At 867j, the playback device 102n checks a role-to-permission cache. For instance, the playback device 102n may determine whether the edge data cache 760 includes or excludes a role-to-permission mapping corresponding to the second token (e.g., in the role-to-permission mappings 761b) (Figure 7). Based on determining that the edge data cache 760 includes a token- to-role mapping corresponding to the second role (i.e., a cache hit) but that the cached data is stale (e.g., because a time-to-live period has expired), the playback device 102n goes to the cloud to attempt to resolve the permissions.
[0168] In particular, at 867k, the playback device 102n sends a conditional request to the authentication services 706b to resolve the permissions. As illustrated in Figure 8 A, the request includes an indication of the second role and an indication of a version of the cached role-to- permission mapping corresponding to the second role. The request may take the form of a HTTP if-modified-since request including an ETag indicating the cached version.
[0169] When receiving such a request, the authentication service 706b may determine whether the stale cached version of the role-to-permission mapping is still up-to-date. The authentication service 706b may make such a determination by comparing the ETag of the cached version of the role-to-permission mapping with an ETag of the version of the role-to-permission mapping at the authentication service 706b. As noted above, the ETags act as a fingerprint of the version. If the ETags match, no change has been made to the role-to-permission mapping. If the ETags are different, the version of the role-to-permission mapping at the authentication service 706b has changed and authentication service 706b responds to the request with the new mappings.
[0170] However, when the ETags match, the authentication service 706b can avoid sending the mappings and can instead respond only with an indication that the cached data previously
42
considered stale is still valid. Such a response may take the form of an HTTP status (e.g., 200 OK) and no body (as the mappings themselves are not necessary). To illustrate, at 8671, the authentication service 706b sends a response to the request to resolve permissions indicating a status (e.g., 200 OK) and an indication of a third time-to-live period (TTL3), which indicates how long the permissions mask for the first role remains valid. In some examples, this time-to-live period may be the same length of time as the second time-to-live period.
[0171] At 867m, the playback device 102n re-caches the role-to-permissions mapping in the edge data cache 760 (e.g., in the role-to-permissions mappings 761b). As noted above, in some examples, the caching is maintained for the second time-to-live period and considered expired after the second time-to-live period. In other examples, the caching is removed from the cache after the second time-to-live period. In either case, the cached role-to-permissions mapping may be used to resolve roles for the second time-to-live period.
[0172] Once the playback device 102n has the permissions set, the playback device 102n may determine whether to accept or reject the command. That is, the playback device 102n may determine that the command is permitted by the resolved permission set and carry out the command at 867n. Conversely, the playback device 102n may determine that the command is prohibited by the resolved permission set and not carry out the command.
[0173] Within examples, at 867o, the playback device 102n may provide a command result to the control device 104b. The command result indicates whether the command was carried out and may also indicate current resource states following the command (which may be updated if the command modified the resource). When receiving the command result, the control device 104b may update a user interface to indicate the result of the command.
[0174] In traditional HTTP caching, a client (e.g., a web browser) caches data from a web server. In contrast, while the example authentication management may utilize features of HTTP caching during authentication management, the playback device 102 including the cache (e.g., the playback device 102n) is caching data on itself to respond to commands (which may take the form of HTTP requests) from one or more clients. That is, as illustrated in Figures 8B and 8C, the playback device 102n may act as an edge server itself to avoid calls to cloud services such as the authentication service 706a and the authentication service 706b. In other words, the playback device 102 operates as a hybrid client and server within the architecture 700.
[0175] In some cases, the playback devices 102 may support two or more different types of commands. For instance, the playback devices 102 may support a legacy API (e.g., universal plug-
43
and play) and a platform API. As another example, the playback devices may support platform API and one or more third-party (APIs), such as Airplay® or Spotify Connect®.
[0176] In such examples, the playback devices 102 may receive a first command according to a first API (e.g., a third party or legacy API) and map the first command to a corresponding command in another API (e.g., the platform API). After mapping, the playback devices 102 may determine whether the corresponding command is permitted by the permission set. Such an implementation may avoid having to implement permissions sets for all supported APIs.
[0177] In some instances, the first command according to the first API may map to two or more second commands in the second API. In such examples, determine whether the first command is permitted by a permission set may involve determining whether each of the two or more second commands are permitted. For instance, a playback command targeting two or more playback devices in the first API may map to a grouping command and a group playback command in the second API. Many other examples are possible.
[0178] To provide further illustration, Figures 9A-9C are functional block diagrams showing examples in the example architecture 700 (Figure 7). Such examples are intended to be representative of authentication management with various clients. Such techniques may be applied using different architectures and clients.
[0179] Figure 9A is an example of authenticating a new client (the control device 104a) that is located on the LAN 111, which is similar to the Figure 8A example. At 965a, the control device 104a sends authentication credentials to the authentication service 706a. The authentication service 706a determines whether the authentication credentials are valid, and if so, sends a token to the control device 104a at 965b.
[0180] At 965 c, the control device 104a sends a command to the playback device 102n via the LAN 111. The command indicates the token. As noted above, the command may take the form of an HTTP request with a header indicating the token.
[0181] After receiving the command, the playback device 102n attempts to resolve the role corresponding to the token. At 965d, the playback device 102n sends a request for a role corresponding to the token to the authentication service 706b. The authentication service 706b determines the token-to-role mapping for the token. As explained above, the authentication service 706b maintains or has access to token-to-role mappings for each token. Within examples, determining the token-to-role mapping for the second token may involve querying a database or
44
other data storage structure for a role matching the object and the token. At 965d, the authentication service 706b sends a response to the playback device 102n. If the token is valid, the response will indicate a success and the resolved role mapping.
[0182] After resolving the role, the playback device 102n next attempts to resolve permissions. At 965f, the playback device 102n sends a request to resolve permissions to the authentication service 706b. The request indicates the role. The authentication service 706b resolves the permission set corresponding to the role. At 965g, the authentication service 706b sends a response indicating the permission set (as a permission mask).
[0183] Once the playback device 102n has the permissions set, the playback device 102n may determine whether to accept or reject the command. That is, the playback device 102n may determine that the command is permitted by the resolved permission set and carry out the command. For instance, the playback device 102n may read or modify a particular namespace of the platform API. Conversely, the playback device 102n may determine that the command is prohibited by the resolved permission set and not carry out the command.
[0184] In some cases, the command targets other or additional playback devices 102 in the media playback system. For instance, the command may target the playback devices 102k and 1021 (and perhaps not the playback device 102, which may act as a point-of-contact for the control device 104a). In such examples, carrying out the command may involve causing the targeted playback devices 102k and 1021 to carry out the command. For instance, at 965h and 965i, the playback device 102 may event changes to the particular namespace over the LAN 111 to the playback devices 102k and 1021, respectively, which cause the playback devices 102k and 1021 to carry out the command.
[0185] A command result may be sent back to the control device 104a. To illustrate, at 965j, the playback device 102n sends a command result. Alternatively, one or both of the playback devices 102k and 1021 may send back a command result.
[0186] Figure 9B is an example of authenticating a new client (the control device 104b) that is not located on the LAN 111 but instead connected to the media playback system 100 via a wide area network. At 966a, the control device 104b sends authentication credentials to the authentication service 706a. The authentication service 706a determines whether the authentication credentials are valid, and if so, sends a token to the control device 104b at 966b.
45
[0187] At 966c, the control device 104b sends a command to the playback device 102n via an API gateway 706c. The API gateway 706c provides a point-of-contact outside of the LAN 111 for clients over the WAN. At 966d, the API gateway 706c sends the command including the token to the playback device 102n.
[0188] After receiving the command, the playback device 102n attempts to resolve the role corresponding to the token. At 966e, the playback device 102n sends a request for a role corresponding to the token to the authentication service 706b. The authentication service 706b determines the token-to-role mapping for the token. At 966f, the authentication service 706b sends a response to the playback device 102n. If the token is valid, the response will indicate a success and the resolved role mapping.
[0189] After resolving the role, the playback device 102n next attempts to resolve permissions. In this example, the role-to-permission caching is cached in the edge data cache 760. As such, the playback device 102n can resolve the permission set without communicating again with the authentication service 706b.
[0190] Once the playback device 102n has resolved the permissions set, the playback device 102n may determine whether to accept or reject the command. That is, the playback device 102n may determine that the command is permitted by the resolved permission set and carry out the command. Conversely, the playback device 102n may determine that the command is prohibited by the resolved permission set and not carry out the command.
[0191] Figure 9C is an example of authenticating a new client (the NMD 103f) that is located on the LAN 111 but includes third-party software (e.g., to process voice inputs via the VAS 190). At 967a, the NMD 103f sends a voice input to the computing devices 106a. At 967b, the computing devices 106a sends authentication credentials to the authentication service 706a. The authentication service 706a determines whether the authentication credentials are valid, and if so, sends a token to the computing devices 106a at 967c.
[0192] At 967d, the computing devices 106a send a command to the playback device 102n via the API gateway 706c. As noted above, the API gateway 706c provides a point-of-contact outside of the LAN 111 for clients over the WAN. At 967 e, the API gateway 706c sends the command including the token to the playback device 102n.
[0193] After receiving the command, the playback device 102n attempts to resolve the role corresponding to the token. At 967f, the playback device 102n sends a request for a role
46
corresponding to the token to the authentication service 706b. The authentication service 706b determines the token-to-role mapping for the token. At 967g, the authentication service 706b sends a response to the playback device 102n. If the token is valid, the response will indicate a success and the resolved role mapping.
[0194] After resolving the role, the playback device 102n next attempts to resolve permissions. In this example, the role-to-permission caching is cached in the edge data cache 760. As such, the playback device 102n can resolve the permission set without communicating again with the authentication service 706b.
[0195] Once the playback device 102n has resolved the permissions set, the playback device 102n may determine whether to accept or reject the command. That is, the playback device 102n may determine that the command is permitted by the resolved permission set and carry out the command. Conversely, the playback device 102n may determine that the command is prohibited by the resolved permission set and not carry out the command.
IV. Example Methods
[0196] F igure 10 is a flow diagram showing an example method 1000 to authenticate a client and carry out a restricted command. The method 1000 may be performed by one or more playback device(s) 102. Alternatively, the method 1000 may be performed by any suitable device or by a system of devices, such as the playback devices 102, the NMDs 103, control devices 104, computing devices 105, computing devices 106, or by smart IOT devices (such as the smart illumination device 108 or smart thermostat 110). For the purposes of illustration, certain features are described as being performed by the playback device 102n and/or the platform servers 706 (Figure 7).
[0197] At block 1002, the method 1000 involves (i) receiving data representing a playback command and (ii) a token corresponding to a client. For example, the playback device 102n may receive, via a first network interface, first data representing (i) a first playback command and (ii) a first token corresponding to a first client, such as the control device 104a (Figures 7, 8A-8B). In some cases, the first client and the playback device are connected to a local area network (Figure 9A). In other cases, clients are not connected to the local area network (e.g., Figure 9B).
[0198] At block 1004, the method 1000 involves resolving a role corresponding to the token. For example, the playback device 102n and the authentication service 706b may resolve a first
47
role corresponding to the first token (Figures 8A) based on a role-to-token mapping. Alternatively, the playback device 102n may resolve a first role corresponding to the first token using an edge data cache (Figure 8B). Within examples, the playback device 102n may cache, in the edge data cache, the first token-to-role mapping that maps the first token to the first role (Figures 8A and 8C).
[0199] In an example, the playback device 102n may determine that an edge data cache (e.g., the edge data cache 760) excludes a token-to-role mapping corresponding to the first token (e.g., 865d in Figure 8A). The playback device 102n may send, via the first network interface to the computing system, a request for a role corresponding to the first token (e.g., 865e in Figure 8A). The platform servers 706 may receive, via a second network interface, the request for the role corresponding to the first token and determine, based on stored role-to-token mappings for a plurality of media playback systems, a first token-to-role mapping that maps the first token to a first role for the media playback system (Figure 8A). The platform servers 706 may send, via the second network interface to the playback device, data representing the first token-to-role mapping for the media playback system and the playback device 102n may receive, via the network interface, a response to the request indicating the first token-to-role mapping that maps the first token to the first role (e.g., 865h in Figure 8A).
[0200] In another example, the playback device 102n may determine that an edge data cache (e.g., the edge data cache 760) includes a token-to-role mapping corresponding to the first token (e.g., 866b in Figure 8B). In such an example, the playback device 102n may resolve the first role based on the edge data cache (e.g., based on a cached token-to-role mapping in the edge data cache 760). In a further example, when cached data in the edge data cache is stale, the playback device 102n may resolve the first role based on a conditional request (Figure 8C).
[0201] At block 1106, the method 1100 involves resolving the permission set corresponding to the resolved role. For example, the playback device 102n and the authentication service 706b may resolve a first permission set corresponding to the first role (Figures 8A) based on a role-to- permission mapping. Alternatively, the playback device 102n may resolve the first permission set corresponding to the first role using an edge data cache (Figure 8B). The permission set may be represented as a permission mask.
[0202] In an example, the playback device 102m may determine that the edge data cache includes a first role-to-permission mapping corresponding to the first role (e.g., 866c in Figure 8B) The first role-to-permission mapping maps the first role to a first permission set. As such, the
48
playback device 102 may resolve the first permission set using the cached first role-to-permission mapping.
[0203] In another example, the playback device 102n may determine that the edge data cache excludes a role-to-permission mapping corresponding to the first token (e.g., 865j in Figure 8A). The playback device 102n may send, via the first network interface to the computing system, a request for a permission set corresponding to the first role (e.g., 865k in Figure 8A). The platform servers 706 may receive, via a second network interface, the request for the permission set corresponding to the first token and determine, based on stored role-to-permission mappings for a plurality of media playback systems, a first role-to-permission mapping that maps the first role to a first permission set for the media playback system (Figure 8 A). The platform servers 706 may send, via the second network interface to the playback device, data representing the first role-to- permission mapping for the media playback system and the playback device 102n may receive, via the network interface, a response to the request indicating the first role-to-permission mapping (e.g., 8651 in Figure 8A).
[0204] At block 1108, the method 100 involves determining that the playback command is permitted by the resolved permission set. For instance, the playback device 102n may determine that the playback command is permitted based on a namespace of a resource being created, read, deleted, modified, or otherwise referenced and a portion of a bitmask indicating permission (or not) for that action (Figure 8A). Other examples are possible as well.
[0205] At block 1010, the method 1000 involves carrying out the playback command. In some examples, the playback device 102n may carry out the playback command on itself. In other examples, such as when the playback device 102n is in a group or different playback devices are targeted (Figure 9A), the playback device 102n may carry out the playback command on the group or on the targeted playback devices.
[0206] In further examples, the method 100 involves caching in an edge data cache (e.g., the edge data cache 760). For instance, the playback device 102n may cache, in the edge data cache, the token-to-role mappings that maps tokens to the corresponding roles (Figure 8A). As another example, the playback device 102n may cache, in the edge data cache, permission-to-role mappings that map the permissions to the corresponding roles (Figure 8A).
[0207] In further examples, the method 1000 involves authenticating additional clients and carrying out additional commands from such clients. Further variations and functions that may be
49
performed as part of the method 1000 are described throughout this disclosure, including in the foregoing sections I, II, and III.
Conclusion
[0208] The description above discloses, among other things, various example systems, methods, apparatus, and articles of manufacture including, among other components, firmware and/or software executed on hardware. It is understood that such examples are merely illustrative and should not be considered as limiting. For example, it is contemplated that any or all of the firmware, hardware, and/or software aspects or components can be embodied exclusively in hardware, exclusively in software, exclusively in firmware, or in any combination of hardware, software, and/or firmware. Accordingly, the examples provided are not the only way(s) to implement such systems, methods, apparatus, and/or articles of manufacture.
[0209] The specification is presented largely in terms of illustrative environments, systems, procedures, steps, logic blocks, processing, and other symbolic representations that directly or indirectly resemble the operations of data processing devices coupled to networks. These process descriptions and representations are typically used by those skilled in the art to most effectively convey the substance of their work to others skilled in the art. Numerous specific details are set forth to provide a thorough understanding of the present disclosure. However, it is understood to those skilled in the art that certain embodiments of the present disclosure can be practiced without certain, specific details. In other instances, well known methods, procedures, components, and circuitry have not been described in detail to avoid unnecessarily obscuring aspects of the embodiments. Accordingly, the scope of the present disclosure is defined by the appended claims rather than the forgoing description of embodiments.
[0210] When any of the appended claims are read to cover a purely software and/or firmware implementation, at least one of the elements in at least one example is hereby expressly defined to include a tangible, non-transitory medium such as a memory, DVD, CD, Blu-ray, and so on, storing the software and/or firmware.
[0211] The present technology is illustrated, for example, according to various aspects described below. Various examples of aspects of the present technology are described as numbered examples (1, 2, 3, etc.) for convenience. These are provided as examples and do not limit the present technology. It is noted that any of the dependent examples may be combined in
50
any combination, and placed into a respective independent example. The other examples can be presented in a similar manner.
[0212] Example 1: A method to be performed in a system comprising a first playback device, the method comprising: receiving, via a first network interface, first data representing (i) a first playback command and (ii) a first token corresponding to a first client; determining that an edge data cache excludes a token-to-role mapping corresponding to the first token; sending, via the first network interface to a computing system, a request for a role corresponding to the first token; receiving, via the first network interface, a response to the request indicating a first token- to-role mapping that maps the first token to a first role; when the edge data cache excludes the token-to-role mapping corresponding to the first token, caching, in the edge data cache, the first token-to-role mapping that maps the first token to the first role; determining that the edge data cache includes a first role-to-permission mapping corresponding to the first role, wherein the first role-to-permission mapping maps the first role to a first permission set; determining that the first playback command is permitted by the first permission set; and based on determining that the first playback command is permitted by the first permission set, carrying out the first playback command.
[0213] Example 2: The method of Example 1, wherein the system further comprises the computing system, and wherein the method further comprises: receiving, via the second network interface, the request for the role corresponding to the first token; determining, based on stored role-to-token mappings for a plurality of media playback systems, the first token-to-role mapping that maps the first token to the first role for the media playback system; and sending, via the second network interface to the playback device, data representing the first token-to-role mapping for the media playback system.
[0214] Example 3: The method of any of Examples 1-2, further comprising: after caching the first token-to-role mapping in the edge data cache, receiving, via the first network interface, second data representing (i) a second playback command and (ii) a second token corresponding to the first client; determining that the edge data cache includes the token-to-role mapping corresponding to the first token; determining that the edge data cache includes the first role-to- permission mapping corresponding to the first role; determining that the second playback command is permitted by the first permission set; and based on determining that the second
51
playback command is permitted by the first permission set, carrying out the second playback command.
[0215] Example 4: The method of any of Examples 1-3, further comprising: receiving, via the first network interface, third data representing (i) a third playback command and (ii) a second token corresponding to a second client; determining that the edge data cache excludes a token-to- role mapping corresponding to the second token; sending, via the first network interface to the computing system, a request for a role corresponding to the second token; receiving, via the first network interface, a response to the request indicating a second token-to-role mapping that maps the second token to a second role; when the edge data cache excludes the token-to-role mapping corresponding to the second token, caching, in the edge data cache, a second token-to-role mapping that maps the second token to the second role; determining that the edge data cache excludes a second role-to-permission mapping corresponding to the second role; sending, via the first network interface to the computing system, a request for a permission set corresponding to the second role; receiving, via the first network interface, a response to the request indicating a second role-to-permission mapping that maps the second role to a second permission set; when the edge data cache excludes the token-to-role mapping corresponding to the second token, caching, in the edge data cache, the second role-to-permission mapping that maps the second role to the second permission set; determining that the third playback command is permitted by the second permission set; and based on determining that the third playback command is permitted by the second permission set, carrying out the third playback command.
[0216] Example 5: The method of Example 4, further comprising: receiving, via the first network interface, fourth data representing (i) a fourth playback command and (ii) the second token corresponding to the second client; determining that the edge data cache includes the token- to-role mapping corresponding to the second token; determining that the edge data cache includes a second role-to-permission mapping corresponding to the second role and that the second role- to-permission mapping is stale as a time-to-live period has expired; sending, via the first network interface to the computing system, a conditional request for a permission set corresponding to the second role, the conditional request indicating a version of the second role-to-permission mapping in the edge data cache; receiving, via the first network interface, a response to the request indicating that the version of the second role-to-permission mapping in the edge data cache matches a version of the second role-to-permission mapping at the computing system; when the response to the request indicating that the version of the second role-to-permission mapping in the
52
edge data cache matches a version of the second role-to-permission mapping at the computing system, re-caching, in the edge data cache, the second role-to-permission mapping that maps the second role to the second permission set for another iteration of the time-to-live period; determining that the fourth playback command is permitted by the second permission set; and based on determining that the fourth playback command is permitted by the second permission set, carrying out the fourth playback command.
[0217] Example 6: The method of any of Examples 1-5, wherein the system further comprises the computing system, and wherein the method further comprises: receiving, via the second network interface, the request for the permission set corresponding to the second role; determining, based on stored role-to-permission mappings, the second role-to-permission mapping that maps the second role to the second permission set; and sending, via the second network interface to the playback device, data representing the second role-to-permission mapping.
[0218] Example 7: The method of any of Examples 1-6, further comprising: before determining that the edge data cache includes the first role-to-permission mapping corresponding to the first role, sending, via the first network interface, a request for the first permission set corresponding to the first role; and caching, in the edge data cache, the first role-to-permission mapping that maps the first role to the first permission set.
[0219] Example 8: The method of any of Examples 1-7, wherein the first client comprises an application executing on a mobile device, and wherein the functions further comprise: sending, via the first network interface to the mobile device, data representing a result of the first playback command, wherein the data representing the result of the first playback command causes the application to update a graphical user interface displayed on the mobile device to indicate the result of the first playback command.
[0220] Example 9: The method of any of Examples 1-8, wherein the first playback command is a volume adjustment command, and wherein the first permission set comprises a first permission mask comprising digits settable to values corresponding to a read permission or a modify permission, the digits comprising a volume permission digit, and wherein determining that the first playback command is permitted by the first permission set comprises determining that the volume permission digit indicates a value corresponding to the modify permission.
53
[0221] Example 10: The method of any of Examples 1-9, wherein receiving the first data representing the first playback command comprises receiving data representing a first universal plug-and play (UPnP) command, and wherein determining that the first playback command is permitted by the first permission set comprises: mapping the first UPnP command to a corresponding first media playback system command; and determining that the first media playback system command is permitted by the first permission set.
[0222] Example 11: The method of any of Examples 1-10, further comprising: receiving, via the first network interface, fifth data representing (i) a fifth playback command, wherein the fifth data excludes a token; determining that the edge data cache excludes a token-to-role mapping corresponding to a token absence; sending, via the first network interface to the computing system, a request for a role corresponding to the token absence; receiving, via the first network interface, a response to the request indicating a token-to-role mapping that maps the token absence to the first role; determining that the edge data cache includes the first role-to-permission mapping corresponding to the first role; determining that the fourth playback command is prohibited by the first permission set; and based on determining that the fourth playback command is prohibited by the first permission set, foregoing carrying out the fourth playback command.
[0223] Example 12: The method of any of Examples 1-11, wherein carrying out the first playback command comprises causing at least one additional playback device of the media playback system to carry out the first playback command.
[0224] Example 13: The method of any of Examples 1-12, wherein the system further comprises the computing system, and wherein the method further comprises: validating the first token, and wherein determining the first token-to-role mapping that maps the first token to the first role for the media playback system comprises determining a particular first token-to-role mapping that maps the validated first token to the first role for the media playback system, wherein an invalid token maps to another role that is different from the first role.
[0225] Example 14: The method of any of Examples 1-13, further comprising: before determining that the edge data cache includes the first role-to-permission mapping corresponding to the first role, sending, via the first network interface to the computing system, an if-modified- since request for a role-to-permission mapping corresponding to the first role, the if-modified- since request indicating a particular time and date;
54
[0226] Example 15: The method of any preceding Example, receiving, via the first network interface, a response to the if-modified-since request indicating that the role-to-permission mapping corresponding to the first role is modified since the particular time and date, wherein the response indicates the first role-to-permission mapping that maps the first role to the first permission set; and caching, in the edge data cache, the first role-to-permission mapping that maps the first role to the first permission set.
[0227] Example 16: A tangible, non-transitory, computer-readable medium having instructions stored thereon that are executable by one or more processors to cause a system to perform the method of any one of Examples 1-15.
[0228] Example 17: A device comprising a network interface, one or more processors, and a tangible, non-tangible computer-readable medium having instructions stored thereon that are executable by the one or more processors to cause the system to perform the method of any of Examples 1-15.
[0229] Example 18: A system comprising a network interface, one or more processors, and a tangible, non-tangible computer-readable medium having instructions stored thereon that are executable by the one or more processors to cause the system to perform the method of any of Examples 1-15.
55
Claims
1. A method for a system comprising a playback device of a media playback system and a computing system, the method comprising: receiving, via a first network interface of the playback device, first data representing (i) a first playback command and (ii) a first token corresponding to a first client, wherein the first client and the playback device are connected to a local area network; when an edge data cache stored at the playback device excludes a token-to-role mapping corresponding to the first token, sending, by the playback device, via the first network interface to the computing system, a request for a role corresponding to the first token, wherein the computing system is outside of the local area network; receiving, by the playback device via the first network interface from the computing system, a response to the request indicating a first token-to-role mapping that maps the first token to a first role; caching, in the edge data cache by the playback device, the first token-to-role mapping that maps the first token to a first role for the media playback system; and when the edge data cache includes a first role-to-permission mapping that maps the first role to a first permission set and the first playback command is permitted by the first permission set, causing, by the playback device the first playback command to be carried out.
2. The method of claim 1, further comprising: after caching the first token-to-role mapping in the edge data cache, receiving, by the playback device via the first network interface, second data representing (i) a second playback command and (ii) a second token corresponding to the first client; and causing, by the playback device, the second playback command to be carried out when: the edge data cache includes the token-to-role mapping corresponding to the first token; and
56
the edge data cache includes the first role-to-permission mapping corresponding to the first role and the second playback command is permitted by the first permission set.
3. The method of claim 1 or 2, further comprising: receiving, by the playback device via the first network interface, third data representing (i) a third playback command and (ii) a second token corresponding to a second client; when the edge data cache excludes a token-to-role mapping corresponding to the second token, sending, by the playback device via the first network interface to the computing system, a request for a role corresponding to the second token; receiving, by the playback device via the first network interface, a response to the request indicating a second token-to-role mapping that maps the second token to a second role; caching, by the playback device in the edge data cache, the second token-to-role mapping that maps the second token to the second role; when the edge data cache excludes a second role-to-permission mapping corresponding to the second role, sending, by the playback device, via the first network interface to the computing system, a request for a permission set corresponding to the second role; receiving, by the playback device via the first network interface, a response to the request indicating a second role-to-permission mapping that maps the second role to a second permission set and caching, in the edge data cache, the second role-to- permission mapping that maps the second role to the second permission set; and based on the determination that the third playback command is permitted by the second permission set, causing, by the playback device, the third playback command to be carried out when the third playback command is permitted by the second permission set.
4. The method of claim 3, further comprising: wherein the playback device is further configured to: receiving, by the playback device via the first network interface, fourth data representing (i) a fourth playback command and (ii) the second token corresponding to the second client;
57
when the edge data cache includes the token-to-role mapping corresponding to the second token and a second role-to-permission mapping corresponding to the second role, wherein the second role-to-permission mapping is stale as a time-to-live period has expired, sending, by the playback device via the first network interface to the computing system, a conditional request for a permission set corresponding to the second role, the conditional request indicating a version of the second role-to- permission mapping in the edge data cache; receiving, by the playback device via the first network interface, a response to the request indicating that the version of the second role-to-permission mapping in the edge data cache matches a version of the second role-to-permission mapping at the computing system; when the response to the request indicating that the version of the second role-to- permission mapping in the edge data cache matches a version of the second role- to-permission mapping at the computing system, re-caching, by the playback device in the edge data cache, the second role-to-permission mapping that maps the second role to the second permission set for another iteration of the time-to- live period; and when the fourth playback command is permitted by the second permission set, causing, by the playback device, the fourth playback command to be carried out.
5. The method of any preceding claim, further comprising: before determining whether the edge data cache includes the first role-to-permission mapping corresponding to the first role: sending, by the playback device via the first network interface, a request for the first permission set corresponding to the first role; and caching, in the edge data cache, the first role-to-permission mapping that maps the first role to the first permission set.
6. The method of any preceding claim, further comprising: sending, by the playback device via the first network interface, to a mobile device, wherein the first client comprises an application executing on the mobile device, data representing a result of the first playback command, wherein the data representing the result of the first playback command causes the application to update a
58
graphical user interface displayed on the mobile device to indicate the result of the first playback command.
7. The method of any preceding claim wherein: the first playback command is a volume adjustment command, the first permission set comprises a first permission mask comprising digits settable to values corresponding to a read permission or a modify permission, the digits comprising a volume permission digit, and the playback device determines whether the volume permission digit indicates a value corresponding to the modify permission to determine whether the first playback command is permitted by the first permission set.
8. The method of any preceding claim, further comprising: when the first playback command is a first universal plug-and play (UPnP) command, mapping, by the first playback device, the first UPnP command to a corresponding first media playback system command to determine whether the first media playback system command is permitted by the first permission set.
9. The method of any preceding claim, further comprising: receiving, by the playback device via the first network interface, fifth data representing a fifth playback command, wherein the fifth data excludes a token; when the edge data cache excludes a token-to-role mapping corresponding to a token absence, sending, by the playback device via the first network interface to the computing system, a request for a role corresponding to the token absence; receiving, by the playback device via the first network interface, a response to the request indicating a token-to-role mapping that maps the token absence to the first role; and when the edge data cache includes the first role-to-permission mapping corresponding to the first role and the fourth playback command is prohibited by the first permission set, foregoing, by the playback device, causing the fourth playback command to be carried out.
59
10. The method of any preceding claim, wherein causing the first playback command to be carried out comprises causing at least one additional playback device of the media playback system to carry out the first playback command.
11. The method of any preceding claim, further comprising: sending, by the first playback device via the first network interface to the computing system, an if-modified-since request for a role-to-permission mapping corresponding to the first role, the if-modified-since request indicating a particular time and date; receiving, by the playback device via the first network interface, a response to the if- modified-since request indicating that the role-to-permission mapping corresponding to the first role is modified since the particular time and date and the first role-to-permission mapping that maps the first role to the first permission set; and caching, by the playback device in the edge data cache, the first role-to-permission mapping that maps the first role to the first permission set.
12. A tangible non-transitory computer-readable medium comprising program instructions that are executable by at least one processor such that a playback device is configured to perform the method of any preceding claim.
13. A playback device comprising: a first network interface; at least one first processor; and at least one first tangible, non-transitory computer-readable medium comprising an edge data cache and first program instructions that are executable by the at least one first processor such that the playback device is configured to perform the method of any of claims 1 to 11.
14. The method of any of claims 1 to 11, further comprising: after receiving, via a second network interface of the computing system, the request for the role corresponding to the first token, sending by the computing system, data representing a first token-to-role mapping that maps the first token to the first role
60
for the media playback system, the token-to-role mapping based on stored role-to- token mappings for a plurality of media playback systems.
15. The method of claim 3, further comprising: receiving, by the computing device via the second network interface, the request for the permission set corresponding to the second role; and send, via the second network interface to the playback device, data representing the second role-to-permission mapping that maps the second role to the second permission set based on stored role-to-permission mappings.
16. A system comprising a playback device of a media playback system and a computing system configured to perform, the system configured to perform the method of any of claims 1 to 11 and 14 to 15.
61
Priority Applications (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
EP22726372.0A EP4338422A1 (en) | 2021-05-10 | 2022-05-09 | Authorization management in a media playback system |
Applications Claiming Priority (4)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
US202163186520P | 2021-05-10 | 2021-05-10 | |
US63/186,520 | 2021-05-10 | ||
US17/662,530 | 2022-05-09 | ||
US17/662,530 US20220360585A1 (en) | 2021-05-10 | 2022-05-09 | Authorization management in a media playback system |
Publications (1)
Publication Number | Publication Date |
---|---|
WO2022241402A1 true WO2022241402A1 (en) | 2022-11-17 |
Family
ID=81851246
Family Applications (1)
Application Number | Title | Priority Date | Filing Date |
---|---|---|---|
PCT/US2022/072211 WO2022241402A1 (en) | 2021-05-10 | 2022-05-09 | Authorization management in a media playback system |
Country Status (1)
Country | Link |
---|---|
WO (1) | WO2022241402A1 (en) |
Citations (3)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
US8234395B2 (en) | 2003-07-28 | 2012-07-31 | Sonos, Inc. | System and method for synchronizing operations among a plurality of independently clocked digital data processing devices |
US8483853B1 (en) | 2006-09-12 | 2013-07-09 | Sonos, Inc. | Controlling and manipulating groupings in a multi-zone media system |
US20200314486A1 (en) * | 2019-04-01 | 2020-10-01 | Sonos, Inc. | Access Control Techniques for Media Playback Systems |
-
2022
- 2022-05-09 WO PCT/US2022/072211 patent/WO2022241402A1/en active Application Filing
Patent Citations (3)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
US8234395B2 (en) | 2003-07-28 | 2012-07-31 | Sonos, Inc. | System and method for synchronizing operations among a plurality of independently clocked digital data processing devices |
US8483853B1 (en) | 2006-09-12 | 2013-07-09 | Sonos, Inc. | Controlling and manipulating groupings in a multi-zone media system |
US20200314486A1 (en) * | 2019-04-01 | 2020-10-01 | Sonos, Inc. | Access Control Techniques for Media Playback Systems |
Non-Patent Citations (3)
Title |
---|
ANONYMOUS: "Authorization - Wikipedia", 6 April 2021 (2021-04-06), pages 1 - 3, XP055940811, Retrieved from the Internet <URL:https://en.wikipedia.org/w/index.php?title=Authorization&oldid=1016282035> [retrieved on 20220711] * |
ANONYMOUS: "Proxy server - Wikipedia", 6 May 2021 (2021-05-06), pages 1 - 15, XP055941215, Retrieved from the Internet <URL:https://en.wikipedia.org/w/index.php?title=Proxy_server&oldid=1021671266> [retrieved on 20220712] * |
ANONYMOUS: "Role-based access control - Wikipedia", 20 February 2021 (2021-02-20), pages 1 - 8, XP055940814, Retrieved from the Internet <URL:https://en.wikipedia.org/w/index.php?title=Role-based_access_control&oldid=1007819513> [retrieved on 20220711] * |
Similar Documents
Publication | Publication Date | Title |
---|---|---|
US11934742B2 (en) | Playback device supporting concurrent voice assistants | |
US20220157307A1 (en) | Systems and Methods of Multiple Voice Services | |
US12089019B2 (en) | Content rules engines for audio playback devices | |
US11696074B2 (en) | Systems and methods for associating playback devices with voice assistant services | |
US11646023B2 (en) | Devices, systems, and methods for distributed voice processing | |
US11315556B2 (en) | Devices, systems, and methods for distributed voice processing by transmitting sound data associated with a wake word to an appropriate device for identification | |
US20210118439A1 (en) | Vas toggle based on device orientation | |
US11740857B2 (en) | Playback session transitions across different platforms | |
EP4088179A1 (en) | Voice verification for media playback | |
US20220360585A1 (en) | Authorization management in a media playback system | |
WO2022241402A1 (en) | Authorization management in a media playback system | |
WO2023019097A1 (en) | Edge data caching in a media playback system | |
WO2024054837A1 (en) | Primary-ambient playback on audio playback devices | |
WO2021252483A1 (en) | Control with distributed command processing | |
WO2024177969A1 (en) | Sound stacking |
Legal Events
Date | Code | Title | Description |
---|---|---|---|
121 | Ep: the epo has been informed by wipo that ep was designated in this application |
Ref document number: 22726372 Country of ref document: EP Kind code of ref document: A1 |
|
WWE | Wipo information: entry into national phase |
Ref document number: 2022726372 Country of ref document: EP |
|
NENP | Non-entry into the national phase |
Ref country code: DE |
|
ENP | Entry into the national phase |
Ref document number: 2022726372 Country of ref document: EP Effective date: 20231211 |