[![CodeQL](https://github.com/openbroadcaster/observer/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/openbroadcaster/observer/actions/workflows/codeql-analysis.yml)

#  OpenBroadcaster Multimedia Framework

## Overview

OBServer is a multimedia framework application that focuses on reliability, accessibility and scalability over a having a bloated range of half baked/buggy features.  It has an organic AJAX interface built with Gstreamer, HTML5 and Javascript to deliver a web application in support of broadcast radio and TV automation, media asset management and dynamic community programming.  One OBServer may manage one or more OBPlayers in a synchronized network configuration or have the server and playout on one device or VM.   There is a robust Plugin Module Architecture with many modules extending the core server application.  The server has a documented API to enable sharing digital media assets and metadata with revocable secure keys.

## Usage Scenarios

<details>
<summary>Broadcast Radio and TV</summary>
<ul><li>Special interest, LPFM, community and multicultural broadcasters</li>
<li>Time and theme based music segments for public spaces</li>
<li>Dynamic Podcast assembler, logging and archiving</li></ul>
</details>

<details>
<summary>CAP Emergency Alerting</summary>
<ul><li>Broadcast Radio and TV</li>
<li>LED Outdoor Signage</li>
<li>CATV Alerts</li></ul>
</details>

<details>
<summary>Video Streaming</summary>
<ul><li>Low power community television</li>
<li>User generated community IPTV channel on CATV</li>
<li>Digital signage and visitor information</li></ul>
</details>

<details>
<summary>Media Asset Management</summary>
<ul><li>Media Asset Management</li>
<li>Media library, versioning and archiving</li>
<li>API Access and secure distribution</li></ul>
</details>

## Installation

To install OpenBroadcaster, you should have a basic understanding of the Linux shell terminal. Once installed, every aspect of your station is managed via OpenBroadcaster's web interface.

Follow our [Install instructions](https://github.com/openbroadcaster/observer/blob/main/install.txt) and Post Installation [Troubleshooting guide](https://support.openbroadcaster.com/troubleshooting#post-installation-server-troubleshooting) for instructions on how to install OpenBroadcaster on your own server.

## Support

If you need help with OpenBroadcaster, the first place you should visit is our [Support](https://support.openbroadcaster.com/) page, which features solutions to a number of commonly encountered issues and questions.

## FAQ

Users have sent us [Frequently Asked Questions](https://openbroadcaster.com/knowledge/frequently-asked-questions) and asked common technical questions.

## Documentation

Documentation and user guides can be found in the project's [Support](https://support.openbroadcaster.com) website: 

## Change Log

Visit our [Change Log](https://openbroadcaster.com/resource/change-log) and project history.

## API Access

All of the functionality and metadata in OBServer, (Media, Playlists,Scheduling) is available through our [Documented API](https://docs.openbroadcaster.com/wip/)

## New feature requests

You can visit our GitHub [Issues](https://github.com/openbroadcaster/observer/issues) pages to submit a new feature request or comment on existing projects.

## Bug and error reports

We rely exclusively on our GitHub [Issues](https://github.com/openbroadcaster/observer/issues) to diagnose, track and update these reports. First, check to make sure the issue you're experiencing isn't already reported. If it is, you can subscribe to the existing ticket for updates on the issue's progress. If your issue or request isn't already reported, click the "New Issue" button to create it. Make sure to follow the template provided, as it asks important details that are very important to our team.

## Contributing

Contributions are more than welcome! You can help us improve OpenBroadcaster by either contributing to the core OBServer or OBPlayer, creating a new module or extending language translations and self help guides. 

Any help is welcome, big or small. We are all learning together.

See our [Contributing Guide](https://github.com/openbroadcaster/observer/blob/main/docs/CONTRIBUTING.md) to learn how to get involved.

Please check out the various GIT projects and components on [OpenBroadcaster](https://github.com/openbroadcaster)

## Code of Conduct

We abide by our [Code of Conduct](https://github.com/openbroadcaster/observer/blob/83c050d1c934b09f5c3c5e7ef0aa338e01af9bf2/CODE_OF_CONDUCT.md) and feel strongly about open, appreciative, and empathetic people joining us. 

## Support OpenBroadcaster

OpenBroadcaster will always be available free of charge. OpenBroadcaster is built and maintained by passionate volunteers and broadcasters, so there may be some delays in getting back to you. We make the best effort possible to resolve issues and answer questions. If you find the software useful and would like to support the project, visit the links below. Your support is greatly appreciated.

Copyright 2012-2021 OpenBroadcaster, Inc.

Licensed under GNU AGPLv3.  See COPYING.

Third-party software utilized by OpenBroadcaster is found in the "extras" directory.
See files in "extras" directory for third-party software license information.