Sound Manager

Manage and customize audio cues for incoming/outgoing calls and messages in CometChat Flutter UI Kit.

AI Agent Component Spec

Field	Value
Package	cometchat_uikit_shared
Import	import 'package:cometchat_uikit_shared/cometchat_uikit_shared.dart';
Class	SoundManager (singleton)
Play sound	SoundManager().play(sound: Sound.incomingMessage)
Stop sound	SoundManager().stop()
Sound events	incomingMessage, outgoingMessage, incomingMessageFromOther, incomingCall, outgoingCall
Source	GitHub

SoundManager is a singleton helper class for managing and playing audio cues — incoming/outgoing calls and messages.

---

Methods

play

Plays the default or custom audio for a sound event.

void play({
  required Sound sound,
  String? customSound,
  String? packageName,
  bool? isLooping,
})

Parameter	Type	Description
sound	Sound	Required. The sound event type to play
customSound	String?	Optional. Asset path for custom sound file
packageName	String?	Optional. Package name when using sounds from another plugin
isLooping	bool?	Optional. Whether to loop the sound (default: false)

// Play default sounds
SoundManager().play(sound: Sound.incomingMessage);
SoundManager().play(sound: Sound.outgoingMessage);

// Play custom sound
SoundManager().play(
  sound: Sound.outgoingMessage,
  customSound: "assets/custom_sound.wav",
);

// Play looping sound (e.g., for incoming call)
SoundManager().play(
  sound: Sound.incomingCall,
  isLooping: true,
);

stop

Stops any currently playing sound.

SoundManager().stop();

---

Sound Enum

Value	Default Asset	When it plays
incomingMessage	assets/sound/incoming_message.wav	New message received
outgoingMessage	assets/sound/outgoing_message.wav	Message sent
incomingMessageFromOther	assets/sound/incoming_message.wav	Message from another conversation
incomingCall	assets/sound/incoming_call.wav	Incoming call detected
outgoingCall	assets/sound/outgoing_call.wav	Outgoing call initiated

---

Usage

import 'package:cometchat_uikit_shared/cometchat_uikit_shared.dart';

// Play incoming message sound
SoundManager().play(sound: Sound.incomingMessage);

// Play outgoing call sound
SoundManager().play(sound: Sound.outgoingCall);

// Play custom notification sound
SoundManager().play(
  sound: Sound.incomingMessage,
  customSound: "assets/sounds/notification.mp3",
);

// Play looping ringtone for incoming call
SoundManager().play(
  sound: Sound.incomingCall,
  isLooping: true,
);

// Stop any playing sound
SoundManager().stop();

Sound behavior varies by OS when the app is in the background.