Quick Start Guide¶

Get your first video call running in under 10 minutes with Altegon Solutions.

Prerequisites¶

System meets minimum requirements
Altegon platform installed (installation guide)
Valid API keys or trial account
Camera and microphone available

Step 1: Verify Installation¶

First, check that your Altegon services are running:

# Check service status
sudo systemctl status altegon-gateway
sudo systemctl status altegon-media
sudo systemctl status altegon-signaling

# Verify API endpoint
curl https://your-domain.com/api/health

Expected response:

{
  "status": "healthy",
  "version": "2.1.0",
  "services": {
    "gateway": "online",
    "media": "online",
    "signaling": "online"
  }
}

Step 2: Create Your First Room¶

Using the Web Interface¶

Open your browser and navigate to https://your-domain.com
Login with your credentials
Click "Create New Room"
Enter room details:
Room Name: "My First Meeting"
Description: "Testing Altegon video calls"
Privacy: Private (default)
Click "Create Room"

Using the API¶

curl -X POST https://your-domain.com/api/rooms \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "name": "My First Meeting",
    "description": "Testing Altegon video calls",
    "privacy": "private",
    "maxParticipants": 10
  }'

Response:

{
  "roomId": "room_abc123",
  "name": "My First Meeting",
  "joinUrl": "https://your-domain.com/room/abc123",
  "hostUrl": "https://your-domain.com/room/abc123?host=true",
  "created": "2025-10-10T14:30:00Z"
}

Step 3: Join Your First Call¶

Option A: Web Browser (Recommended)¶

Click the join URL from Step 2
Allow camera and microphone permissions when prompted
Enter your display name
Click "Join Meeting"

Option B: Direct API Integration¶

// Initialize Altegon SDK
const altegon = new AltegonSDK({
  apiKey: 'YOUR_API_KEY',
  serverUrl: 'https://your-domain.com'
});

// Join room
const session = await altegon.joinRoom({
  roomId: 'room_abc123',
  displayName: 'John Doe',
  audio: true,
  video: true
});

// Handle events
session.on('participantJoined', (participant) => {
  console.log('Participant joined:', participant.name);
});

session.on('participantLeft', (participant) => {
  console.log('Participant left:', participant.name);
});

Step 4: Test Core Features¶

Enable Video¶

// Turn video on/off
await session.setVideoEnabled(true);
await session.setVideoEnabled(false);

Enable Audio¶

// Mute/unmute audio
await session.setAudioEnabled(false); // mute
await session.setAudioEnabled(true);  // unmute

// Start screen sharing
await session.startScreenShare();

// Stop screen sharing
await session.stopScreenShare();

Chat Messages¶

// Send chat message
await session.sendMessage({
  text: 'Hello everyone!',
  type: 'text'
});

// Listen for messages
session.on('messageReceived', (message) => {
  console.log(`${message.sender}: ${message.text}`);
});

Step 5: Invite Participants¶

The easiest way to invite participants:

Room: My First Meeting
Join URL: https://your-domain.com/room/abc123
Meeting ID: abc123

Generate Invitation Links¶

curl -X POST https://your-domain.com/api/rooms/abc123/invite \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "email": "colleague@company.com",
    "role": "participant",
    "expiresIn": "24h"
  }'

Email Integration¶

// Send email invitation
await altegon.sendInvitation({
  roomId: 'room_abc123',
  recipients: ['user1@company.com', 'user2@company.com'],
  subject: 'Join our video meeting',
  message: 'You are invited to join our video call.'
});

Step 6: Basic Room Management¶

As a Host¶

Manage Participants¶

// Mute all participants
await session.muteAllParticipants();

// Remove participant
await session.removeParticipant('participant_id');

// Grant presenter role
await session.grantPresenterRole('participant_id');

Recording¶

// Start recording
const recording = await session.startRecording({
  quality: 'high',
  includeAudio: true,
  includeVideo: true,
  includeScreenShare: true
});

// Stop recording
await session.stopRecording();

Room Settings¶

// Lock room (no new participants)
await session.lockRoom();

// Enable waiting room
await session.enableWaitingRoom(true);

// Set room password
await session.setRoomPassword('secure123');

Troubleshooting Quick Issues¶

Camera/Microphone Not Working¶

Check browser permissions:
Click the camera/microphone icon in address bar
Ensure permissions are granted
Test in different browser:
Chrome is recommended for best compatibility

Check device availability:

// List available devices
const devices = await navigator.mediaDevices.enumerateDevices();
console.log('Available devices:', devices);

Poor Video Quality¶

Check network speed:
```
# Test bandwidth
speedtest-cli
```

Adjust quality settings:

// Set video quality
await session.setVideoQuality('medium'); // low, medium, high

Monitor connection:

session.on('connectionQuality', (quality) => {
  console.log('Connection quality:', quality); // poor, fair, good, excellent
});

Audio Echo or Feedback¶

Use headphones (recommended)

Check microphone settings:

// Enable noise cancellation
await session.setAudioProcessing({
  noiseCancellation: true,
  echoCancellation: true,
  autoGainControl: true
});

Next Steps¶

Congratulations! You've successfully: - ✅ Created your first room - ✅ Joined a video call - ✅ Tested basic features - ✅ Invited participants

Continue Learning¶

Video Platform Features - Explore advanced features
API Documentation - Build custom integrations
Configuration - Customize your setup
Integration Guides - Add to your applications

Get Support¶

Documentation: Continue reading our guides
Community: Join our developer community
Support: Contact our technical support team
Training: Schedule a personalized demo

Congratulations!

You're now ready to start building amazing video communication experiences with Altegon Solutions!

Sample Integration Code¶

Here's a complete HTML example to get you started:

<!DOCTYPE html>
<html>
<head>
    <title>My First Altegon Video Call</title>
    <script src="https://cdn.altegon-solutions.com/sdk/v2/altegon.min.js"></script>
</head>
<body>
    <div id="video-container"></div>
    <button id="join-btn">Join Call</button>
    <button id="leave-btn">Leave Call</button>

    <script>
        const altegon = new AltegonSDK({
            apiKey: 'YOUR_API_KEY',
            serverUrl: 'https://your-domain.com'
        });

        let session = null;

        document.getElementById('join-btn').onclick = async () => {
            session = await altegon.joinRoom({
                roomId: 'room_abc123',
                displayName: 'Test User',
                container: document.getElementById('video-container')
            });
        };

        document.getElementById('leave-btn').onclick = async () => {
            if (session) {
                await session.leave();
            }
        };
    </script>
</body>
</html>