Skip to content

Add RealTimeText to sample #251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 17, 2024
Merged

Add RealTimeText to sample #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9fcf28c
Add RealTimeText to sample
edwardlee-msft Dec 16, 2024
f564794
Update Captions to properly show captionLanguage
edwardlee-msft Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Project/src/App.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1148,6 +1148,13 @@ div.volumeVisualizer::before {
transform: translateZ(0);
}

.scrollable-rtt-container {
overflow: auto;
max-height: 300px;
display: flex;
flex-direction: column-reverse;
}

.custom-video-effects-buttons:not(.outgoing) {
display: flex;
position: absolute;
Expand Down
85 changes: 48 additions & 37 deletions Project/src/MakeCall/CallCaption.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@ import { Dropdown } from 'office-ui-fabric-react/lib/Dropdown';
// CallCaption react function component
const CallCaption = ({ call }) => {
const [captionsFeature, setCaptionsFeature] = useState(call.feature(Features.Captions));
const [capabilitiesFeature, setCapabilitiesFeature] = useState(call.feature(Features.Capabilities));
const [captions, setCaptions] = useState(captionsFeature.captions);
const [currentSpokenLanguage, setCurrentSpokenLanguage] = useState(captions.activeSpokenLanguage);
const [currentCaptionLanguage, setCurrentCaptionLanguage] = useState(captions.activeCaptionLanguage);
const [currentCaptionLanguage, setCurrentCaptionLanguage] = useState(null);
let captionLanguageCurrent = null;


useEffect(() => {
try {
Expand All @@ -23,7 +26,7 @@ const CallCaption = ({ call }) => {
captions.off('CaptionsActiveChanged', captionsActiveHandler);
captions.off('CaptionsReceived', captionsReceivedHandler);
captions.off('SpokenLanguageChanged', activeSpokenLanguageHandler);
if (captions.captionsType === 'TeamsCaptions') {
if (captions.kind === 'TeamsCaptions' && capabilitiesFeature.capabilities.setCaptionLanguage?.isPresent) {
captions.off('CaptionLanguageChanged', activeCaptionLanguageHandler);
}
};
Expand All @@ -37,7 +40,12 @@ const CallCaption = ({ call }) => {
captions.on('CaptionsActiveChanged', captionsActiveHandler);
captions.on('CaptionsReceived', captionsReceivedHandler);
captions.on('SpokenLanguageChanged', activeSpokenLanguageHandler);
if (captions.captionsType === 'TeamsCaptions') {
capabilitiesFeature.on('CapabilitiesChanged', (value) => {
if (value.newValue.setCaptionLanguage) {
setCapabilitiesFeature(call.feature(Features.Capabilities));
}
});
if (captions.kind === 'TeamsCaptions' && capabilitiesFeature.capabilities.setCaptionLanguage?.isPresent) {
captions.on('CaptionLanguageChanged', activeCaptionLanguageHandler);
}
} catch (e) {
Expand All @@ -55,46 +63,49 @@ const CallCaption = ({ call }) => {

const captionsActiveHandler = () => {
console.log('CaptionsActiveChanged: ', captions.isCaptionsFeatureActive);
setCurrentSpokenLanguage(captions.activeSpokenLanguage);
setCurrentCaptionLanguage(captions.activeCaptionLanguage);
}
const activeSpokenLanguageHandler = () => {
setCurrentSpokenLanguage(captions.activeSpokenLanguage);
}
const activeCaptionLanguageHandler = () => {
setCurrentCaptionLanguage(captions.activeCaptionLanguage);
captionLanguageCurrent = captions.activeCaptionLanguage;
}

const captionsReceivedHandler = (captionData) => {
let mri = '';
if (captionData.speaker.identifier.kind === 'communicationUser') {
mri = captionData.speaker.identifier.communicationUserId;
} else if (captionData.speaker.identifier.kind === 'microsoftTeamsUser') {
mri = captionData.speaker.identifier.microsoftTeamsUserId;
} else if (captionData.speaker.identifier.kind === 'phoneNumber') {
mri = captionData.speaker.identifier.phoneNumber;
}

let captionAreasContainer = document.getElementById('captionsArea');
const newClassName = `prefix${mri.replace(/:/g, '').replace(/-/g, '').replace(/\+/g, '')}`;
const captionText = `${captionData.timestamp.toUTCString()}
${captionData.speaker.displayName}: ${captionData.captionText ?? captionData.spokenText}`;

let foundCaptionContainer = captionAreasContainer.querySelector(`.${newClassName}[isNotFinal='true']`);
if (!foundCaptionContainer) {
let captionContainer = document.createElement('div');
captionContainer.setAttribute('isNotFinal', 'true');
captionContainer.style['borderBottom'] = '1px solid';
captionContainer.style['whiteSpace'] = 'pre-line';
captionContainer.textContent = captionText;
captionContainer.classList.add(newClassName);
captionContainer.classList.add('caption-item')

captionAreasContainer.appendChild(captionContainer);

} else {
foundCaptionContainer.textContent = captionText;

if (captionData.resultType === 'Final') {
foundCaptionContainer.setAttribute('isNotFinal', 'false');
if (!captionLanguageCurrent || captionLanguageCurrent === captionData.captionLanguage) {
let mri = '';
switch (captionData.speaker.identifier.kind) {
case 'communicationUser': { mri = captionData.speaker.identifier.communicationUserId; break; }
case 'microsoftTeamsUser': { mri = captionData.speaker.identifier.microsoftTeamsUserId; break; }
case 'phoneNumber': { mri = captionData.speaker.identifier.phoneNumber; break; }
}
let captionAreasContainer = document.getElementById('captionsArea');
const newClassName = `prefix${mri.replace(/:/g, '').replace(/-/g, '').replace(/\+/g, '')}`;
const captionText = `${captionData.timestamp.toUTCString()}
${captionData.speaker.displayName ?? mri}: ${captionData.captionText ?? captionData.spokenText}`;

let foundCaptionContainer = captionAreasContainer.querySelector(`.${newClassName}[isNotFinal='true']`);

if (!foundCaptionContainer) {
let captionContainer = document.createElement('div');
captionContainer.setAttribute('isNotFinal', 'true');
captionContainer.style['borderBottom'] = '1px solid';
captionContainer.style['whiteSpace'] = 'pre-line';
captionContainer.textContent = captionText;
captionContainer.classList.add(newClassName);
captionContainer.classList.add('caption-item')

captionAreasContainer.appendChild(captionContainer);

} else {
foundCaptionContainer.textContent = captionText;

if (captionData.resultType === 'Final') {
foundCaptionContainer.setAttribute('isNotFinal', 'false');
}
}
}
};
Expand All @@ -113,7 +124,7 @@ const CallCaption = ({ call }) => {
onChange={spokenLanguageSelectionChanged}
label={'Spoken Language'}
options={keyedSupportedSpokenLanguages}
styles={{ label: {color: '#edebe9'}, dropdown: { width: 100 } }}
styles={{ label: {color: '#edebe9'}, dropdown: { width: 100 }, root: {paddingBottom: '1rem'} }}
/>
}

Expand All @@ -131,14 +142,14 @@ const CallCaption = ({ call }) => {
onChange={captionLanguageSelectionChanged}
label={'Caption Language'}
options={keyedSupportedCaptionLanguages}
styles={{ label: {color: '#edebe9'}, dropdown: { width: 100, overflow: 'scroll' } }}
styles={{ label: {color: '#edebe9'}, dropdown: { width: 100, overflow: 'scroll' }, root: {paddingBottom: '1rem'} }}
/>
}

return (
<>
{captions && <SpokenLanguageDropdown/>}
{captions && captions.captionsType === 'TeamsCaptions' && <CaptionLanguageDropdown/>}
{captions && captions.kind === 'TeamsCaptions' && capabilitiesFeature.capabilities.setCaptionLanguage?.isPresent && <CaptionLanguageDropdown/>}
<div className="scrollable-captions-container">
<div id="captionsArea" className="captions-area">
</div>
Expand Down
121 changes: 121 additions & 0 deletions Project/src/MakeCall/CallCard.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import CallCaption from "./CallCaption";
import Lobby from "./Lobby";
import { ParticipantMenuOptions } from './ParticipantMenuOptions';
import MediaConstraint from './MediaConstraint';
import RealTimeTextCard from "./RealTimeTextCard";

export default class CallCard extends React.Component {
constructor(props) {
Expand All @@ -40,6 +41,9 @@ export default class CallCard extends React.Component {
this.raiseHandFeature = this.call.feature(Features.RaiseHand);
this.capabilitiesFeature = this.call.feature(Features.Capabilities);
this.capabilities = this.capabilitiesFeature.capabilities;
if (Features.RealTimeText) {
this.realTimeTextFeature = this.call.feature(Features.RealTimeText);
}
this.dominantSpeakersFeature = this.call.feature(Features.DominantSpeakers);
this.recordingFeature = this.call.feature(Features.Recording);
this.transcriptionFeature = this.call.feature(Features.Transcription);
Expand Down Expand Up @@ -86,6 +90,9 @@ export default class CallCard extends React.Component {
callMessage: undefined,
dominantSpeakerMode: false,
captionOn: false,
realTimeTextOn: false,
firstRealTimeTextReceivedorSent: false,
showCanNotHideorCloseRealTimeTextBanner: false,
dominantRemoteParticipant: undefined,
logMediaStats: false,
sentResolution: '',
Expand All @@ -111,6 +118,10 @@ export default class CallCard extends React.Component {
this.isSetCallConstraints = this.call.setConstraints !== undefined;
}

setFirstRealTimeTextReceivedorSent = (state) => {
this.setState({ firstRealTimeTextReceivedorSent: state });
}

componentWillUnmount() {
this.call.off('stateChanged', () => { });
this.deviceManager.off('videoDevicesUpdated', () => { });
Expand Down Expand Up @@ -468,6 +479,7 @@ export default class CallCard extends React.Component {
this.recordingFeature.on('isRecordingActiveChanged', this.isRecordingActiveChangedHandler);
this.transcriptionFeature.on('isTranscriptionActiveChanged', this.isTranscriptionActiveChangedHandler);
this.lobby?.on('lobbyParticipantsUpdated', this.lobbyParticipantsUpdatedHandler);
this.realTimeTextFeature?.on('realTimeTextReceived', this.realTimeTextReceivedHandler);
}
}

Expand Down Expand Up @@ -649,6 +661,62 @@ export default class CallCard extends React.Component {
this.capabilities = this.capabilitiesFeature.capabilities;
}

realTimeTextReceivedHandler = (rttData) => {
this.setState({ realTimeTextOn: true });
if (!this.state.firstRealTimeTextReceivedorSent) {
this.setState({ firstRealTimeTextReceivedorSent: true });
}
if (rttData) {

let mri = '';
let displayName = '';
switch (rttData.sender.identifier.kind) {
case 'communicationUser': { mri = rttData.sender.identifier.communicationUserId; displayName = rttData.sender.displayName; break; }
case 'microsoftTeamsUser': { mri = rttData.sender.identifier.microsoftTeamsUserId; displayName = rttData.sender.displayName; break; }
case 'phoneNumber': { mri = rttData.sender.identifier.phoneNumber; displayName = rttData.sender.displayName; break; }
}

let rttAreaContainer = document.getElementById('rttArea');

const newClassName = `prefix${mri.replace(/:/g, '').replace(/-/g, '').replace(/\+/g, '')}`;
const rttText = `${(rttData.receivedTimestamp).toUTCString()} ${displayName ?? mri} isTyping: `;

let foundRTTContainer = rttAreaContainer.querySelector(`.${newClassName}[isNotFinal='true']`);

if (!foundRTTContainer) {
if (rttData.text.trim() === '') {
return
}
let rttContainer = document.createElement('div');
rttContainer.setAttribute('isNotFinal', 'true');
rttContainer.style['borderBottom'] = '1px solid';
rttContainer.style['whiteSpace'] = 'pre-line';
rttContainer.textContent = rttText + rttData.text;
rttContainer.classList.add(newClassName);

rttAreaContainer.appendChild(rttContainer);

setTimeout(() => {
rttAreaContainer.removeChild(rttContainer);
}, 40000);
} else {
if (rttData.text.trim() === '') {
rttAreaContainer.removeChild(foundRTTContainer);
}
if (rttData.resultType === 'Final') {
foundRTTContainer.setAttribute('isNotFinal', 'false');
foundRTTContainer.textContent = foundRTTContainer.textContent.replace(' isTyping', '');
if (rttData.isLocal) {
let rttTextField = document.getElementById('rttTextField');
rttTextField.value = null;
}
} else {
foundRTTContainer.textContent = rttText + rttData.text;
}
}
}
}

dominantSpeakersChanged = () => {
const dominantSpeakersMris = this.dominantSpeakersFeature.dominantSpeakers.speakersList;
const remoteParticipants = dominantSpeakersMris.map(dominantSpeakerMri => {
Expand Down Expand Up @@ -1455,6 +1523,27 @@ export default class CallCard extends React.Component {
<Icon iconName="TextBox" />
}
</span>
{ Features.RealTimeText &&
<span className="in-call-button"
title={`${this.state.realTimeTextOn ? 'Hide RealTimeText Card' : 'Show RealTimeText Card'}`}
variant="secondary"
hidden={this.state.callState !== 'Connected'}
onClick={() => {
if (!this.state.firstRealTimeTextReceivedorSent) {
this.setState((prevState) => ({ realTimeTextOn: !prevState.realTimeTextOn }))
} else {
this.setState((prevState) => ({ showCanNotHideorCloseRealTimeTextBanner: true}))
}}}>
{
this.state.realTimeTextOn &&
<Icon iconName="Comment" />
}
{
!this.state.realTimeTextOn &&
<Icon iconName="Comment" />
}
</span>
}
<span className="in-call-button"
title={`${this.state.showDataChannel ? 'Turn data channel off' : 'Turn data channel on'}`}
variant="secondary"
Expand Down Expand Up @@ -1741,6 +1830,38 @@ export default class CallCard extends React.Component {
</div>
</div>
}
{
Features.RealTimeText && this.state.realTimeTextOn &&
<div className="mt-5">
<div className="ms-Grid-row">
<h3>RealTimeText</h3>
</div>
<div className="md-grid-row">
{
this.state.realTimeTextOn &&
this.state.firstRealTimeTextReceivedorSent &&
this.state.showCanNotHideorCloseRealTimeTextBanner &&
<MessageBar
messageBarType={MessageBarType.warn}
isMultiline={true}
onDismiss={() => { this.setState({ showCanNotHideorCloseRealTimeTextBanner: undefined }) }}
dismissButtonAriaLabel="Close">
<b>Note: RealTimeText can not be closed or hidden after you have sent or received a message.</b>
</MessageBar>
}
{
this.state.realTimeTextOn &&
<RealTimeTextCard
call={this.call}
state={{
firstRealTimeTextReceivedorSent: this.state.firstRealTimeTextReceivedorSent,
setFirstRealTimeTextReceivedorSent: this.setFirstRealTimeTextReceivedorSent
}}
/>
}
</div>
</div>
}
{
this.state.showDataChannel &&
<div className="mt-5">
Expand Down
Loading
Loading