User Tools

Site Tools


document_window

BoinxTV Document Window

The main window is divided is several sections:

1 Layer Setting

Each layer in the Layer Stack can have multiple Layer Settings. The parameters of a Layer Setting can be adjusted in the Layer Settings Panel on the left of the document window. Please watch Working With Layers And Settings to learn more about Layer Settings.

Layer Settings
Description
At the top of the left Layer Settings panel you see the name and a preview of the layer. The title bar will be red if the selected setting is LIVE. The areas of the preview that have checkerboard are transparent. You can detach the preview into a separate window by clicking the button on the top right.
In this bar you see the current selected setting of a layer. Each layer can have multiple settings. you can scroll through the settings with the arrow buttons on the left and the right. You can rename the setting by double clicking the settings name in the layer stack in the middle of the document window.
You can configure here if a layer should respond to certain events or setup a keyboard short cut for a certain layer setting. Please watch Using Keyboard And Event Triggers to learn more about this feature.
Each Layer has an individual set of parameters to control its behavior and appearance. Please find a list of all available Layer Parameter Types here.

2 Layer Stack

In the middle of the window there is the layer stack. It contains all the layers that are used to render the final video. You can add layers here by dragging them from the Layers Repository to the Layer Stack. Keep in mind that the layers gets rendered to the video canvas in the order they are stacked: from bottom to top. You can rearrange them the way you want by dragging the layers around. To remove a layer you have two options:

  • Select the layer you want to delete and select the menu item Layer ⇢ Delete (⌘⌫).
  • Right-click on the layer to get a context menu where you can select Delete

As an example of a layer stack object we explain the functionality by a Lower Third Layer containing three layer settings:

Screenshot Description
At the left there is an icon which gives you a hint which layer type you are seeing.
This is the Layer Name. By default it is the layer's type. You can change it by double clicking it or select the menu item Layer ⇢ Rename.
Next to the Layer's Name you find the Keyboard Shortcut for the Live trigger of the layer. The key combination can be set in the Layer Setting section of the window. If this key combination is pressed this layer will get switched on or off regardless of which setting is selected.
Some of the layers can switch off automatically after a certain time. This countdown gives you a hint when this will happen. The display will turn orange if the countdown is less than 3 seconds.
The box in the middle contains all the settings for this layer. Usually you only have one setting, but for some layers it makes sense to have multiple settings so that the content can be switched easily. It also makes sure that only one content is present at the same time. In the top left corner there is a toggle to switch from vertical to horizontal layout. In the top right corner you see a plus button to duplicate the current setting. Right next to this button there is an context menu button where you are able to rename a setting or delete it. You are also able to rename a setting by double clicking on the settings name (in this sample double click on John Doe - CEO). In the middle there is a list of settings for this layer. The one with the red dot is currently live. The highlighted row (the second one) is currently selected to be edited in the layer settings panel on the left side. Each setting can have its own keyboard shortcut trigger which is displayed on the right in each row. The small Live Buttons at the end can be used to make a certain setting live.
The big Live Button indicates if a layer is currently live. Depending on the behavior of the used layer type, it may not be visible in the live output. You can click the button to switch the layer on and off. Some layers need some time to finally switch off (e.g. doing a fade out). Those layers will get a yellow Live button indicating this state. You may force the switching off by clicking the yellow button again.
Some layers will also have an audio meter and volume control which is not shown in this example.

3 Live Output View

In the top right corner there is the live output view. Here you can see what your final product will look like. There are three buttons in the upper right corner of this section:

Button Menu equivalent Description
View ⇢ Pause Rendering If you want to save CPU cycles when working in another application you can switch off the video rendering. This option is disabled during a recording session.
View ⇢ Toggle Fullscreen (⌘B) Switches fullscreen output on or off. You may be asked to select the display for fullscreen output if you have connected a secondary monitor to your machine. You can make this selection in the Preferences
View ⇢ Show/Hide Live Output in Window You can open or close a floating window showing the live output. You can place this window anywhere on your desktop.

Please read BoinxTV Menus : Views about additional options for the Live Output Window.

4 Layers and Sources Repository

At the bottom there is either the Layers Repository or the Sources Repository depending on the switch in the lower left corner.

Layers Repository

On the left you see a filter to narrow down your search for layers. You can select a single category or multiple categories or you can do a text search with the search field at the bottom. The layer list in the middle will show only the matching layers. Choose the Reset button on the top left to clear your filter.

In the middle you see the layers list. It contains all the layers shipped with BoinxTV as well as your custom made layers. You can scroll down the list with the scroll handle on the right side. Drag a layer to the Layer Stack above to add it to the video output. If your layer repository is empty, you probably setup a filter on the left. Use the Reset button on the top left to clear your filter to get all available layers back.

Selecting a layer will show information about it in the info panel on the right. Clicking the + button in the lower right corner or double-clicking the layer will add it above the currently selected layer in your show. Right-clicking will show more options about where to place the new layer in your stack.

Sources Repository

On the left you see a filter to narrow your search for sources. You can select a category or do a text search with the search field at the bottom. The source list in the middle will show only the matching sources. Choose the Reset button on the top left to clear your filter.

In the middle you see the sources list. You can scroll down the list with the scroll handle on the right side. To make use of your sources drag them to the appropriate layer in the layer stack. Drop zones will appear on each layer that accepts that kind of source. Alternatively you can select the sources in the Source popup menu in the Layer Settings of the desired layer. If your source repository is empty, you probably setup a filter on the left that gives you no results. Use the Reset button on the top left to clear your filter to get all available sources back.

Once you select a source from the list a source inspector will show up in the info panel on the right. Source types have different information panels and setup options. In the top right corner of those panels you can select a context menu with the following options:

Source Context Menu

Menu Item
Description
Settings… If the selected source is a screen source it will show the border of the capture area.
Chroma Key Source… If the selected source is a visual one you can create a new source which applies a chroma key filter to it. Please watch Using The Chroma Keyer and Using The Chroma Keyer Pro to learn more about chroma keying in BoinxTV.
Filter Source… If the selected source is a visual one you can create a new source which applies a filter to it.
Rename… This menu item lets you rename the source so that it makes more sense to you.
Quick Look Opens up a window showing the Mac OSX Quick Look content for this media file. Pressing the space bar does the same thing.
Show In Finder Opens a Finder window with the media file in question selected.
Make Selected Devices Persistent If you make a device persistent, BoinxTV won't exchange it with a different video source if the selected on isn't available at startup.
Choose File for Source… Lets you replace the current media file with another one.
Pixel Aspect Ratio You can specify a certain pixel aspect ratio for video devices. Leave it to Automatic if you don't have a good reason to switch it to a fixed value.
Looped (Only available for movie sources) If this menu item has a check mark the movie will loop endless when played within any layer.

Source Inspectors

Source Inspector
Description
Camera Inspector: A camera source is a combination of two real input devices: a video device and an audio device where as the audio device is optional (you setup the devices in Device Preferences). There are two popups where you can select the associated devices. At the bottom you get specific information about the provided data streams. To learn more about camera sources watch the Working With Sources And Devices Movie
Audio Inspector: An audio source represents a single audio device. You have to select an audio device in the Audio Device popup menu (you setup the devices in Device Preferences). At the bottom you get specific information about the provided data stream. To learn more about audio sources watch the Working With Sources And Devices Movie
Media Inspector: A media source can be a movie, audio or image file or even a QuartzComposer document. Next to the preview of the media you are able to select the way BoinxTV will reference this media file: Absolute Reference means that only the full Mac OSX file path of the media will be stored. This is useful if you have media at a specific location that won't get moved around over time. Copied into Document means that this media file will become part of the document as a copy. The benefit is that you can't loose those media files when moving your documents around. The third option is Media Folder Relative. If you set up a Common Media Folder in the General Preferences then only the path of the media file relative to this media folder get stored. This is helpful if you want to share BoinxTV documents and have the same media folder on different machines but with different usernames (the option Absolute Reference won't work in this scenario). At the bottom you get specific information about the media file. To learn more about media sources watch Playing Movies
Screen Source Inspector: If you want to do a screencast or capture some live content from the web, use this tool. You can create a screen source by selecting Source ⇢ Add Screen Source. To see what part of your screen is currently captured click the Show button on the right. You will get a black frame representing the capture area. you can reposition it and resize it. For your convenience there is a popup menu where you can select the BoinxTV document size or the screen size as the capture area dimensions.
Filtered Source Inspector: If you created a filtered source you can inspect which source gets filtered and what kind of filter is applied to it. Select Edit Chromakey Filter… or Edit Source Filter… from the context menu in the upper right corner to adjust the filter to your needs.

5 Recording And Status Display

In the Recording and Status Display you find useful information about the running recording session and the status of the rendering process.

Element Description
Recording/Rolling: This indicator shows up if the show timer is running. If you have not selected to record to disk, it will say Rolling instead of Recording.
Recording To Disk: If this icon is shown BoinxTV will record your show to disk when you press the record button.
Run In Full Screen: This icons tells you that BoinxTV will enter Full Screen Mode once you start a recording.
Show Timer: In the middle there is the Show Timer. It can either count up or down depending on the Show Timer Settings of the document. When counting down the recording will stop automatically at zero.
Memory Warning: The memory warning is shown when ever BoinxTV is going to run out of memory. Currently BoinxTV can handle 4 GB of RAM and will crash once this limit has reached. When the memory warning is shown you should release some large resources like movies or big layers.
VRAM Warning: BoinxTV also monitors the memory usage of the graphics card. When using lots of visual media the VRAM could fill up and cause the computer to stall. Check if you can reduce the usage of big media files.
Dropping Video Frames In Source: When the machine is under heavy CPU load it usually starts dropping frames from video sources. Please check the Activity Monitor application to see where the CPU load comes from and try to avoid it.
Dropping Audio: For some reason the audio buffer is full and BoinxTV has to drop audio blocks. Sometimes this is caused by an unsupported audio sampling rate.
Dropping Frames: Sometimes the rendering process takes more time than a video frame lasts. In those cases BoinxTV has to drop a video frame in the recording. Try to switch off layers that render a lot of content.
GPU Performance Meter: This meter tells you how long the rendering of a single video frame takes compared to the duration of a video frame. If 100% is reached BoinxTV usually risks dropping frames.

At the very top right of the document window are the master audio options. The meter shows the level of the audio being recorded and should never illuminate the red dots on the right which indicate clipping. The headphone icon reveals options to Enable Playthrough. If this is enabled the audio will also be output to the selected playthrough device. The volume fader affects the monitoring volume as well as the level of the recorded audio.

document_window.txt · Last modified: 2013/06/08 18:04 by david