setUserName()

setUserName(name, options?) In Daily Prebuilt, the name appears as a video overlay and in the chat. In custom call object builds, it is available on the user_name property of the local DailyParticipant object.

Parameters

name

string

required

The display name to set.

options.thisMeetingOnly

boolean

When true, the name change applies only for the current meeting and does not persist to the participant’s profile. Defaults to false.

Return value

Returns a Promise that resolves to { userName: string } — the name that was set.

Example

const { userName } = await call.setUserName('Ada Lovelace');
console.log('Name set to:', userName);

// Change name for this meeting only
await call.setUserName('Ada (presenting)', { thisMeetingOnly: true });