Chapter 1: Introduction to WINK Forge

1.1 Overview

WINK Forge is an enterprise-grade video transcoding and streaming platform that transforms video content for optimal delivery across diverse networks and devices. As the cornerstone of the WINK Streaming ecosystem, WINK Forge provides robust video processing capabilities that enable organizations to deploy comprehensive video streaming solutions.

Key Capabilities

• Multi-Protocol Support: Ingest and deliver video using RTMP, RTSP, SRT, HLS, MPEG-DASH, WebRTC, and more
• Enterprise Integration: Native integration with Genetec, Milestone, and other major VMS platforms
• Adaptive Streaming: Automatic bitrate adaptation for optimal viewing experience
• Security Features: SSL/TLS encryption, access control lists, and authentication mechanisms
• High Performance: Optimized encoding supporting up to 8K resolution

Learn more about WINK Forge features on our product page.

1.2 System Architecture

WINK Forge operates on a modular architecture designed for scalability and reliability:

1.3 Deployment Options

Hardware Appliance

Pre-configured hardware solutions optimized for video processing:

• 1U and 2U rackmount servers
• Enterprise-grade components
• Redundant power supplies and RAID storage
• Pre-installed and optimized firmware

Virtual Appliance (V-Forge)

Deploy on your existing virtualization infrastructure:

• VMware vSphere compatible
• Hyper-V support
• KVM/QEMU compatible
• OVF/OVA templates available
• Docker containers for microservices deployment
• Kubernetes orchestration support

Cloud Deployment (Cloud Forge)

Fully managed cloud instances:

• AWS EC2 optimized AMIs
• Azure marketplace images
• Google Cloud Platform support
• Auto-scaling capabilities

Chapter 2: Getting Started

2.1 Web Interface Access

The WINK Forge web administration interface provides complete control over all system functions. Access methods vary by firmware version:

Firmware 8.x (Current)

• Primary Access: https://[IP-ADDRESS]:444
• Alternative: https://[IP-ADDRESS]:443/wink-admin/

Legacy Firmware

2.2 Default Credentials

Initial system access requires the default credentials:

Username: admin
Password: admin_pass
Shared Key: admin_key
    

2.3 Security Configuration

SSL Certificate Management

Configure SSL certificates for secure access:

1. Navigate to Settings → System Options → SSL Certificate
2. Choose one of the following options:
   • Generate self-signed certificate
   • Upload existing certificate (PFX format)
   • Use Let's Encrypt (requires public domain)
3. Apply changes and restart web services

Shared Key Authentication

The shared key system provides an additional layer of security, particularly useful for:

• PCI-DSS compliance requirements
• Scheduled password rotations
• Multi-user environments

To configure shared key authentication:

# API call example
curl -X POST https://forge.example.com/api/ \
  --data-urlencode "<wink_api user='admin' pass='password' key='shared_key'>
    <req id='1' command='version'></req>
  </wink_api>"
    

Chapter 3: Input Configuration

3.1 Supported Input Types

WINK Forge supports a comprehensive range of input protocols and formats. While it can handle any codec, H.264 inputs are strongly preferred for field deployments:

RTSP (Real Time Streaming Protocol)

Most common for IP cameras and encoders. WINK Forge automatically detects RTSP streams and negotiates the best transport method:

rtsp://username:password@192.168.1.100:554/stream1
rtsp://camera.example.com/live/channel1
rtsps://secure-camera.example.com:8554/stream  # RTSP over TLS
    

RTMP (Real Time Messaging Protocol)

Popular for live streaming applications:

rtmp://server.example.com/live/streamkey
rtmp://localhost/live/camera1
rtmps://secure.example.com:443/live/stream  # RTMP over TLS
    

HTTP/HTTPS Streams

Including MJPEG, HLS, and MPEG-DASH sources:

http://camera.example.com/mjpeg.cgi
https://server.example.com/hls/stream.m3u8
https://cdn.example.com/dash/manifest.mpd
https://camera.local/snapshot.jpg?fps=1  # Image sequence
    

UDP/RTP/SRT Streams

For multicast, low-latency, and secure reliable transport:

udp://239.1.1.1:1234
rtp://224.0.0.1:5004
srt://192.168.1.100:9000?mode=caller&passphrase=mykey
srt://srt-server.example.com:9000?streamid=mystream
    

VMS Integrations

• Genetec: Direct SDK integration with Security Center
• Milestone: Native protocol support for XProtect
• ONVIF: Profile S/G/T compliant camera control
• Avigilon: Unity Video integration
• ExacqVision: Universal driver support

Automatic Codec Detection

WINK Forge automatically detects and handles incoming codecs:

3.2 Input Settings

Basic Configuration

Video Parameters

Input Format Auto-Detection

WINK Forge intelligently detects input parameters when "Auto" is selected:

1. Protocol Detection: Analyzes URL scheme and probes endpoints
2. Codec Identification: Reads stream headers to identify H.264, H.265, or other codecs
3. Resolution Discovery: Extracts frame dimensions from video stream
4. Frame Rate Analysis: Calculates actual FPS from timestamps
5. Audio Detection: Identifies audio tracks and codecs

Cropping Options

Remove unwanted portions of the video frame:

• Crop Top: Pixels to remove from top edge
• Crop Bottom: Pixels to remove from bottom edge
• Crop Left: Pixels to remove from left edge
• Crop Right: Pixels to remove from right edge

3.3 Advanced Input Options

Authentication Methods

Configure authentication for protected sources:

# Basic Authentication
rtsp://username:password@host/path

# Digest Authentication (automatic)
Input will negotiate digest auth when required

# Custom Headers (HTTP/HTTPS only)
Add in Advanced Options:
http_headers="Authorization: Bearer TOKEN"
    

Network Optimization

Metadata Mapping

Associate metadata with streams for downstream applications:

• Logical ID: Numeric identifier for VMS mapping
• Group ID: Category or zone assignment
• Latitude/Longitude: GPS coordinates for mapping applications

Chapter 4: Output Configuration

4.1 Output Formats

WINK Forge supports multiple simultaneous outputs per input, enabling diverse distribution strategies:

Streaming Protocols

Output Path Configuration

Configure output destinations based on protocol:

# HLS Output
/hls/stream_name

# RTMP Push
rtmp://cdn.example.com/live/streamkey

# RTSP Server
rtsp://0.0.0.0:8554/stream1

# SRT Push
srt://backup.site.com:9000?streamid=camera1&passphrase=secret

# WebRTC
/webrtc/stream_name
    

4.2 Encoding Settings

Video Encoding Parameters

H.264 - The Field-Proven Standard

IMPORTANT: H.264 is the default and recommended codec for almost all field deployments, especially traffic cameras and any camera connected via wireless, cellular, or high-latency networks. While newer codecs exist, H.264 remains the gold standard for reliability.

H.265/HEVC - Use Cases and Warnings

While WINK Forge fully supports H.265 (HEVC), it should only be used in specific controlled environments:

H.265 Encoding Parameters

# Efficient H.265 encoding
Codec: libx265
Preset: medium (balance quality/speed)
Profile: main or main10 (for HDR)
Level: auto (based on resolution/framerate)

# Example for CONTROLLED ENVIRONMENT ONLY
Resolution: 3840x2160
Bitrate: 15000 Kbps (vs 25000 for H.264)
Keyframe: 60 frames

WARNING: Never use H.265 for cameras on wireless/cellular networks!
    

Bitrate Guidelines

Audio Configuration

4.3 Adaptive Streaming

Creating Adaptive Bitrate Ladders

Configure multiple outputs with different qualities for adaptive streaming:

Chapter 5: Media Protocols

5.1 RTMP Configuration

RTMP Server Mode

Accept incoming RTMP streams:

# Input configuration
Type: RTMP
Path: rtmp://0.0.0.0:1935/live/stream1

# Publishers connect to:
rtmp://forge.example.com:1935/live/stream1
    

RTMP Push Mode

Send streams to CDN or streaming services:

# Output configuration
Format: RTMP
Path: rtmp://a.rtmp.youtube.com/live2/xxxx-xxxx-xxxx-xxxx
    

RTMP Authentication

Secure RTMP endpoints with token authentication:

# Enable in Settings → RTMP Rebroadcast
Authentication: Token
Token Lifetime: 3600 seconds

# Client URL with token
rtmp://forge.example.com/live/stream1?token=abc123
    

5.2 SRT Configuration

SRT (Secure Reliable Transport)

SRT provides encrypted, reliable streaming over unpredictable networks:

SRT Modes

SRT Parameters

# Input with encryption
Type: SRT
Path: srt://source.com:9000?passphrase=SecureKey123&latency=200

# Output with stream ID
Format: SRT
Path: srt://backup.site:9000?streamid=camera1&passphrase=key

# Key SRT options:
latency=120        # Latency in milliseconds (default: 120)
maxbw=0           # Max bandwidth (0 = unlimited)
pbkeylen=16       # Encryption key length (16, 24, or 32)
lossmaxttl=0      # Packet loss tolerance
    

5.3 RTSP Configuration

RTSP Server Setup

# Output configuration
Format: RTSP
Path: rtsp://0.0.0.0:8554/stream1

# Access URL
rtsp://forge.example.com:8554/stream1
    

RTSP Transport Modes

RTSP Authentication

# Basic authentication
rtsp://username:password@forge.example.com:8554/stream1

# Digest authentication (automatic negotiation)
Configured in user management
    

5.4 HLS/LL-HLS

Standard HLS Configuration

# Output settings
Format: HLS
Path: /hls/stream1
Segment Duration: 6 seconds
Playlist Length: 5 segments

# Access URL
https://forge.example.com/hls/stream1/playlist.m3u8
    

Low-Latency HLS (LL-HLS)

# Enable LL-HLS
Format: LL-HLS
Part Duration: 0.33 seconds
Segment Duration: 2 seconds

# Client requirements
- HTTP/2 support
- Byte-range requests
- Modern player (HLS.js 1.0+)
    

HLS Encryption

Protect content with AES-128 encryption:

1. Generate encryption keys
2. Configure key server URL
3. Enable encryption in output settings

5.5 MPEG-DASH

DASH Configuration

# Output settings
Format: DASH
Path: /dash/stream1
Segment Duration: 4 seconds
Min Buffer Time: 1.5 seconds

# Manifest URL
https://forge.example.com/dash/stream1/manifest.mpd
    

DASH Features

• Multi-period support: Insert ads or alternate content
• Subtitle tracks: WebVTT sidecar files
• DRM support: Widevine and PlayReady
• Low latency mode: Chunked transfer encoding

Chapter 6: VMS Integration

6.1 Genetec Integration

Genetec Security Center

WINK Forge provides native integration with Genetec Security Center through the SDK:

Virtual Encoder Configuration

1. In Security Center Config Tool, add new encoder
2. Select "WINK Streaming" from manufacturer list
3. Enter WINK Forge IP address and credentials
4. Discover available streams automatically

Stream URL Format

# Genetec-compatible RTSP URL
rtsp://forge.example.com:554/genetec/[GUID]_[quality]

# Example
rtsp://forge.example.com:554/genetec/WF05-1234-5678-90AB-CDEF_high
    

Virtual Decoder Setup

Use WINK Forge as a Genetec Virtual Decoder:

# Input configuration
Type: Genetec
Path: [Genetec server details configured in plugin]

# Capabilities
- Multi-stream decoding
- PTZ passthrough
- Event forwarding
    

6.2 Milestone Integration

Milestone XProtect

Configure WINK Forge as a universal driver device:

Stream Configuration

# MJPEG for maximum compatibility
Output Format: MJPEG
Path: /mjpeg/camera1
FPS: 10-15 (reduce bandwidth)

# RTSP for better quality
Output Format: RTSP
Path: rtsp://0.0.0.0:554/camera1
    

6.3 VMS to VMS Bridging

WINK Forge excels at bridging between incompatible VMS platforms:

Common Bridging Scenarios

Camera Protocol Emulation

Make any source appear as a standard IP camera:

• ONVIF Profile S: Standard streaming
• Axis VAPIX: Axis camera emulation
• Panasonic: Legacy support
• Sony VISCA: PTZ control support

Chapter 7: API Reference

7.1 API Overview

The WINK Forge API provides complete programmatic control over all system functions. All API calls require SSL and authentication.

API Endpoint

https://forge.example.com/api/

Authentication

<wink_api user='username' pass='password' key='shared_key'>
    <req id='1' command='command_name'>payload</req>
</wink_api>
    

Response Format

<wink_api>
    <resp id="1" command="command_name" status="ok">response_data</resp>
</wink_api>
    

7.2 Stream Control Commands

Start/Stop/Restart Streams

Example: Restart Stream

<wink_api user='apiuser' pass='apipass'>
    <req id='1' command='restart'>WF05-2657-1C04-7F1B-5EC0</req>
</wink_api>
    

Stream Status

Get GUID Status

<wink_api user='apiuser' pass='apipass'>
    <req id='1' command='guidstatus'>WF05-1EDA-1C04-6E33-ABF9</req>
</wink_api>

Response values:
0 = Not publishing
1 = Publishing
2 = Blocked
3 = Unavailable
    

Block/Unblock Streams

Input Management

Create/Update Input

<wink_api user='apiuser' pass='apipass'>
    <req id='1' command='input_source'>
        <input title='Camera 1' 
               desc='Main entrance' 
               type='RTSP' 
               path='rtsp://192.168.1.100:554/stream1'
               enabled='1' />
    </req>
</wink_api>
    

Input Parameters

7.3 User Management API

Create User

<wink_api user='admin' pass='adminpass'>
    <req id='1' command='createuser'>
        <name>John Smith</name>
        <username>jsmith</username>
        <password>SecurePass123!</password>
        <access>2</access>
    </req>
</wink_api>

Access Levels:
1 = Admin
2 = Operator  
3 = Viewer
4 = API Only
    

Change Password

<wink_api user='admin' pass='adminpass'>
    <req id='1' command='changepassword'>
        <username>jsmith</username>
        <password md5='false'>NewPass456!</password>
    </req>
</wink_api>
    

Chapter 8: Advanced Features

8.1 One-Time Password (OTP) Authentication

OTP provides temporary access tokens for secure stream viewing, ideal for:

• Time-limited access to streams
• Integration with web applications
• Secure sharing of live content

OTP Workflow

1. Application requests OTP token from WINK Media Router
2. Token generated with specified duration
3. Client uses token to access stream
4. Token expires after duration or single use

API Commands

Create OTP Token

curl -d "apiuser=apiuser&apipass=apipass&action=create&duration=60&hash_type=alphanumeric&hash_length=32" \
     -X POST https://router.example.com/otp/api/

Response: 24814928371014572819abc123def456
    

OTP Parameters

Using OTP Tokens

# Append token to stream URL
https://forge.example.com/hls/stream1/playlist.m3u8?token=24814928371014572819abc123def456
    

8.2 Watermarking

Image Watermarks

Add logos or branding to video streams:

1. Upload watermark image (PNG with transparency recommended)
2. Configure in output settings:
   • Watermark File: Select uploaded image
   • Position: topleft, topright, bottomleft, bottomright
   • X-Pad: Horizontal offset in pixels
   • Y-Pad: Vertical offset in pixels
   • Opacity: 0.0 (transparent) to 1.0 (opaque)

Text Overlays

Add dynamic text to streams:

Timestamp Formats

# Predefined formats
YYYY-MM-DD HH:MM:SS
MM/DD/YYYY HH:MM:SS
DD/MM/YYYY HH:MM:SS

# Custom format (strftime)
%Y-%m-%d %I:%M:%S %p
    

8.3 PTZ Control

PTZ Passthrough

WINK Forge can relay PTZ commands between VMS systems and cameras:

PTZ Configuration

1. Enable PTZ in input settings
2. Configure control protocol
3. Map PTZ URLs for passthrough
4. Test with VMS PTZ controls

8.4 Advanced Auto-Detection

WINK Forge's intelligent auto-detection system eliminates manual configuration for most streams:

Auto-Detection Process

1. Protocol Analysis
   • URL scheme detection (rtsp://, rtmp://, srt://, etc.)
   • Port scanning for common protocols
   • Protocol negotiation and handshake
2. Stream Analysis
   • SDP parsing for RTSP streams
   • Metadata extraction from RTMP
   • Container format identification
3. Codec Detection
   • H.264 profile and level detection
   • H.265 tier and profile identification
   • Audio codec and channel configuration
4. Parameter Optimization
   • Buffer size based on bitrate
   • Keyframe interval detection
   • Network transport optimization

Supported Auto-Detection Scenarios

Manual Override Options

When auto-detection needs assistance:

# Force specific codec detection
advanced_options="analyzeduration=5000000"

# Override detected parameters
force_codec="h265"
force_fps="30"
force_resolution="1920x1080"

# Custom probe size for difficult streams
probesize="10M"
    

Chapter 9: Monitoring & Analytics

9.1 Real-time Dashboard

WINK Forge provides comprehensive monitoring through its web interface dashboard:

Dashboard Overview

• Active Streams: Live count and status of all streams
• System Resources: CPU, memory, and network utilization
• Bandwidth Usage: Input/output bandwidth graphs
• Error Log: Recent errors and warnings
• Stream Health: Color-coded status indicators

Stream Status Indicators

9.2 Stream Statistics

Per-Stream Metrics

Click on any stream to view detailed statistics:

Export Statistics

Export historical data for analysis:

• CSV Export: Raw metrics for spreadsheet analysis
• JSON API: Programmatic access to statistics
• SNMP: Integration with network monitoring systems
• Prometheus: Metrics endpoint for Grafana dashboards

9.3 Alert Configuration

Alert Types

Configure automatic notifications for critical events:

Alert Delivery Methods

1. Email: SMTP configuration in Settings
2. Webhook: HTTP POST to your endpoint
3. SNMP Trap: To network monitoring system
4. Syslog: To centralized logging
5. SMS: Via configured gateway (optional)

Chapter 10: Troubleshooting

Common Issues and Solutions

Stream Not Starting

Poor Video Quality

• Pixelation: Increase bitrate or reduce resolution
• Stuttering: Check CPU usage, reduce FPS
• Color issues: Verify color space settings
• Artifacts: Adjust encoder preset (faster = lower quality)

High CPU Usage

1. Check transcoding load:

   top -n 1 | grep ffmpeg

2. Reduce quality settings:
   • Lower resolution
   • Decrease FPS
   • Use optimized encoder settings
3. Optimize encoder settings:

   Preset: ultrafast (lowest CPU)
   Profile: baseline (simpler encoding)
   Codec: Consider H.265 for better compression

Network Diagnostics

Built-in Tools

Access via Tools menu in web interface:

Log Analysis

Check system logs for errors:

# Web interface
Tools → Logs → System Logs

# Command line
tail -f /var/log/winkforge/stream.log
grep ERROR /var/log/winkforge/system.log
    

H.265 Specific Issues

SRT Connection Issues

Common Log Messages

# Requirements
- Public domain name
- Port 80 accessible from internet
- DNS pointing to WINK Forge

# Automatic renewal
Certificates renew automatically every 60 days
        

# Increase file descriptors
ulimit -n 65536

# Optimize network buffers
sysctl -w net.core.rmem_max=134217728
sysctl -w net.core.wmem_max=134217728

# CPU governor for performance
cpupower frequency-set -g performance
        

Input:
  Type: RTSP
  Path: rtsp://camera.local:554/stream1
  Auto-detect: Enabled

Outputs:
  1. HLS Low (360p)
     Resolution: 640x360
     Bitrate: 800 Kbps
     Path: /hls/camera1_low
  
  2. HLS Medium (720p)
     Resolution: 1280x720
     Bitrate: 2500 Kbps
     Path: /hls/camera1_med
  
  3. HLS High (1080p)
     Resolution: 1920x1080
     Bitrate: 5000 Kbps
     Path: /hls/camera1_high

Master Playlist: /hls/camera1/master.m3u8

CODEC NOTE: All outputs use H.264 - DO NOT use H.265 for field cameras!
        

Input:
  Type: RTSP
  Path: rtsp://4k-camera.local/h265stream
  Codec: H.265 (auto-detected)

Output:
  Format: RTMP
  Path: rtmp://cdn.example.com/live/camera
  Codec: H.264
  Profile: High
  Bitrate: 8000 Kbps (40% higher than source)
  Preset: fast (balance quality/CPU)
  
NOTE: This is fixing a deployment mistake. New cameras should use H.264 from the start.
        

Input:
  Type: SRT (Listener)
  Path: srt://0.0.0.0:9000?mode=listener
  Passphrase: ProductionKey2025
  Latency: 500ms

Outputs:
  1. Program Feed
     Format: RTSP
     Path: rtsp://0.0.0.0:554/program
     
  2. Backup Stream
     Format: SRT (Caller)
     Path: srt://backup.site:9000?streamid=main
     
  3. Web Preview
     Format: HLS
     Path: /hls/preview
     Bitrate: 1000 Kbps
        

Input:
  Type: Genetec
  Source: Via SDK integration
  Original: H.265 + G.711 audio

Outputs:
  1. Milestone Compatible
     Format: RTSP
     Codec: H.264 Baseline
     Audio: AAC
     Resolution: Maintain original
     
  2. Archive Copy
     Format: File (MP4)
     Codec: H.265 (preserve)
     Segment: 1 hour files
        

Input:
  Type: RTSP
  Original: 4K @ 15 Mbps

Outputs:
  1. Remote Site A (Limited bandwidth)
     Resolution: 1280x720
     Bitrate: 1500 Kbps
     FPS: 15
     Codec: H.265 (better compression)
     
  2. Remote Site B (Very limited)
     Resolution: 640x360
     Bitrate: 500 Kbps
     FPS: 10
     Codec: H.264  # Still H.264 for reliability!
     
  3. Local Recording
     Resolution: Original (4K)
     Codec: H.264  # H.265 only if on fiber/local network
     Quality: High
     
IMPORTANT: Even for "bandwidth optimization", H.264 is preferred.
The minor savings from H.265 don't justify the reliability risks.