Using Zixi Documentation
8 min
before we get into the quick starts for zen master and broadcaster, here are a few tips on getting around in this documentation site and getting answers to your questions site navigation zixi documentation is divided into several major sections that appear in the site navigation on the left site navigation note that on narrower displays, the site navigation may not appear automatically, but you can still access by clicking the icon in the upper left corner to open the site navigation the major sections here is a brief description of what you'll find in the major sections zixi documentation home the home page, but also release notes for broadcaster and zen master, as well as a page that shows recent additions and updates to the documentation quick start the section you are in now, which also includes instructions for getting started quickly with zen master and broadcaster product features high level overviews of some key zixi features, such as redundancy, error correction, working with tams, and so forth broadcaster vxx current version documentation for the current version of broadcaster and zec (when you go to that section, you will also find links to documentation for previous but still supported versions) zen master documentation for zen master zaas a one page explanation of zixi as a service, which is zen master used with broadcasters that zixi sets up and maintains in the cloud for you market switching covers zixi's tools for inserting scte messages into streams for purposes such as creating pre rolls or ad breaks, providing regionalized content to different receivers, and switching to different content in situations where content is blacked out in particular areas for regulatory or contractual reasons how to guides guides for cross product things like security, related apps like vlc, obs, and wirecast, zixi's onair pro mobile app, etc zen master api not the api reference, which is found on the customer portal https //portal zixi com , but guides to some common basic api tasks, as well as configuring api keys, setting up the api in postman, and such troubleshooting despite zixi's elaborate array of tools to ensure that your video streams get to their destinations intact and on time, things happen this section contains troubleshooting guides to help you fix or mitigate issues when they arise customer portal a guide to the portal where you can download zixi software, get licenses, find additional documentation, and more navigating the sections when you click on any of the main sections, the section navigation will open up below the links to the main sections when you click on one of the subsections of the main section, it will expand to reveal links to the documents and subsections it contains note that an arrow to the right of a link (as shown in the image above) indicates that there are additional documents and/or subsections contained in it these will open up when you click the link searching and asking ai at the top of every page is a search bar, and beside it a button to ask ai search , like most search engines, will return a list relevant documents, with brief text highlighting where the search terms appear search results note that if you would rather see the ai response, you can click ask ai in the search results ask ai , on the other hand, provides a summary of the topic you searched on based on what it found within all the documents ask ai response note that you can click the icon highlighted in the image above to see a list of the documents that ai used to generate its summary which should i use? if you are already fairly familiar with zixi's documentation and simply want to get back to a document you know to check on a detail, search can be very effective on the other hand, if you are looking for answer to a question, we recommend trying ask ai instead here's why zixi provides many features that can be used across a variety of broadcaster inputs, adaptive groups, and outputs, or zen master sources, channels, and targets if you go to a document on adding a specific item, you will find a brief explanation of all the available fields however, if you are trying to understand what the feature does, and in what cases you would want to use it, there are often higher level documents with deeper explanations of features and how they work together the ai summaries are often more effective in leading you to the high level explanations also remember that ai responses are generally more useful when you ask questions, providing context for what you are trying to figure out, rather than just providing search terms for example (referring to the images above), instead of prompting ai with "fec", try asking something like "what is fec, and how does it work with other mechanisms to fix errors in transmitting video streams? do i just need one, or do they work together?"
