Struct Group 

pub struct Group {
    pub id: GroupId,
    pub coordinator_id: SpeakerId,
    pub member_ids: Vec<SpeakerId>,
    pub volume: GroupVolumeHandle,
    pub mute: GroupMuteHandle,
    pub volume_changeable: GroupVolumeChangeableHandle,
    /* private fields */
}

Group handle with access to coordinator and members

Provides access to group information and member speakers. All speakers are always in a group - a single speaker forms a group of one.

Example

// Get all groups
for group in system.groups() {
    println!("Group: {} ({} members)", group.id, group.member_count());
     
    if let Some(coordinator) = group.coordinator() {
        println!("  Coordinator: {}", coordinator.name);
    }
     
    for member in group.members() {
        let role = if group.is_coordinator(&member.id) { "coordinator" } else { "member" };
        println!("  - {} ({})", member.name, role);
    }
}

Fields

id: GroupId

Unique group identifier

coordinator_id: SpeakerId

Coordinator speaker ID

member_ids: Vec<SpeakerId>

All member speaker IDs (including coordinator)

volume: GroupVolumeHandle

Group volume (0-100)

mute: GroupMuteHandle

Group mute state

volume_changeable: GroupVolumeChangeableHandle

Whether group volume can be changed (event-only, no fetch)

Implementations

impl Group

pub fn coordinator(&self) -> Option<Speaker>

Get the coordinator speaker

Returns the Speaker handle for the group’s coordinator. Returns None if the coordinator speaker is not found in state.

Example

if let Some(coordinator) = group.coordinator() {
    println!("Coordinator: {}", coordinator.name);
    // Control playback via coordinator
    let state = coordinator.playback_state.get();
}

pub fn members(&self) -> Vec<Speaker>

Get all member speakers

Returns Speaker handles for all members in the group, including the coordinator. Only returns speakers that are found in state.

Example

for member in group.members() {
    println!("Member: {} ({})", member.name, member.model_name);
}

pub fn speaker(&self, name: &str) -> Option<Speaker>

Get a member speaker by name

Returns None if no member with that name exists in this group.

Example

let group = sonos.group("Living Room").unwrap();
if let Some(kitchen) = group.speaker("Kitchen") {
    println!("Kitchen is in the Living Room group");
}

pub fn is_coordinator(&self, speaker_id: &SpeakerId) -> bool

Check if a speaker is the coordinator of this group

Example

for member in group.members() {
    if group.is_coordinator(&member.id) {
        println!("{} is the coordinator", member.name);
    }
}

pub fn member_count(&self) -> usize

Get the number of members in this group

Example

println!("Group has {} members", group.member_count());

pub fn is_standalone(&self) -> bool

Check if this is a standalone group (single speaker)

A standalone group contains only one speaker, which is also the coordinator.

Example

if group.is_standalone() {
    println!("This speaker is not grouped with others");
}

pub fn add_speaker(&self, speaker: &Speaker) -> Result<(), SdkError>

Add a speaker to this group

Sends SetAVTransportURI to the member speaker with x-rincon:{coordinator_id} to join the coordinator’s audio stream. This is the standard Sonos grouping mechanism. After calling this, re-fetch groups via system.groups() to see updated membership.

pub fn remove_speaker(&self, speaker: &Speaker) -> Result<(), SdkError>

Remove a speaker from this group

Sends BecomeCoordinatorOfStandaloneGroup to the member speaker, causing it to leave the group and become standalone. Cannot remove the coordinator.

pub fn dissolve(&self) -> GroupChangeResult

Dissolve this group by removing all non-coordinator members

Attempts to remove every non-coordinator member, even if some fail. Returns a GroupChangeResult showing which speakers were successfully removed and which failed. For standalone groups, returns an empty result.

pub fn set_volume(&self, volume: u16) -> Result<(), SdkError>

Set group volume (0-100)

Updates the state cache to the new GroupVolume on success.

pub fn set_relative_volume( &self, adjustment: i16, ) -> Result<SetRelativeGroupVolumeResponse, SdkError>

Adjust group volume relative to current level

Returns the new absolute volume.

pub fn set_mute(&self, muted: bool) -> Result<(), SdkError>

Set group mute state

Updates the state cache to the new GroupMute value on success.

pub fn snapshot_volume(&self) -> Result<(), SdkError>

Snapshot the current group volume (for later restore)

Trait Implementations

impl Clone for Group

fn clone(&self) -> Group

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.