Gathering Media Logs from the Skype Web SDK or Conversation Control

In this article:

If your failing scenario involves using Audio/Video with the Skype Web SDK or Conversation Control, please include the appropriate media logs in your bug report. The media logs are in a binary format and require specific software and symbol files to view and interpret so you will not be able to view the media log on your own.

Depending on the browser and OS in which you're running the Skype Web SDK or Conversation Control, the location of media logs will vary. See below for the instructions on gathering media logs specific to your browser.

Media logs in Internet Explorer

Using Audio/Video in Internet Explorer requires the Skype For Business media plugin. The location of the logs will depend on where the plugin is installed. If the plugin is installed in the default install location on a Windows machine, the path of the log files looks like this:

%LOCALAPPDATA%\Microsoft\SkypeForBusinessPlugin\Tracing

After reproducing the scenario, close the browser, navigate to this directory and select the two most recently modified files with the extension .etl. Their names should look like this:

PluginHost_MediaStack-<BUILD_NUMBER>-releases_CL2016_R12-x86fre-U.etl
PluginHost_MediaStackETW-<BUILD_NUMBER>-releases_CL2016_R12-x86fre-U.etl

Include both files in the issue report.

Media logs in Microsoft Edge

Using Audio/Video in the Skype Web SDK in Microsoft Edge uses the Microsoft Edge native implementation of the ORTC (Object Real-Time Communications) protocol. In order to collect media logs for Audio/Video activity in Microsoft Edge, you must first enable Microsoft Edge ORTC media logging by setting a registry key.

Enable Microsoft Edge ORTC media logging

On a Windows machine, you can do so by running this Powershell script:

$regPath = "registry::hkcu\Software\Classes\Local Settings\Software\Microsoft\Windows\CurrentVersion\AppContainer\Storage\microsoft.microsoftedge_8wekyb3d8bbwe\MicrosoftEdge\ORTC"

if (!(Test-Path $regPath)) {
    New-Item -Path $regPath -Force | Out-Null
}

$reg = Get-Item -Path $regPath
if (!$([bool]($reg.PSObject.Properties.Value -match "EnableOrtcEngineTracing"))) {
    New-ItemProperty -Path $regPath -Name "EnableOrtcEngineTracing" -PropertyType DWORD -Value 1
    Write-Output "ORTC media logging enabled."
} else {
    Set-ItemProperty -Path $regPath -Name "EnableOrtcEngineTracing" -Value 1
    Write-Output "ORTC media logging re-enabled"
}

This script will enable media logging in Microsoft Edge until you delete or set the registry key added here to 0.

Copy logs to your home directory

After enabling media logging in this way, restart Microsoft Edge, reproduce the failing scenario, close the the browser and run the following Powershell script:

# copies Edge media logs to a specified location

[CmdletBinding()]
Param(
    # Final component of name for folder where logs will be copied
    [Parameter(Mandatory=$True)]
    [string]$issueDescription,

    # Another component of name for folder where logs will be copied
    [Parameter(Mandatory=$True)]
    [string]$organizationName
)

$loc = Get-Location

Set-Location $ENV:LOCALAPPDATA\Packages\Microsoft.MicrosoftEdge_8wekyb3d8bbwe\

# Find most recent log of each of 2 types
$items = Get-ChildItem -Filter OrtcEngine_MediaStack-*.etl -Recurse
$latestLog1 = $items[0]
$items | ForEach-Object {
    if ($_.LastWriteTime -gt $latestLog1.LastWriteTime) {
        $latestLog1 = $_
    }
}

$items = Get-ChildItem -Filter OrtcEngine_MediaStackETW-*.etl -Recurse
$latestLog2 = $items[0]
$items | ForEach-Object {
    if ($_.LastWriteTime -gt $latestLog2.LastWriteTime) {
        $latestLog2 = $_
    }
}

$date = Get-Date 
$logFormat = "{0}-{1}-{2}-{3}-{4:D2}{5:D2}-{6}\"
$logDir = $logFormat -f $ENV:USERNAME, $ENV:COMPUTERNAME, $organizationName, $date.Year, $date.Month, $date.Day, $issueDescription

$destPath = "$ENV:HOMEDRIVE\$ENV:HOMEPATH\"
if (!(Test-Path $destPath$logDir)) {
    mkdir $destPath$logDir | Out-Null
}

$log1Name = "$destPath$logDir$latestLog1"
$log2Name = "$destPath$logDir$latestLog2"

Copy-Item $latestLog1.FullName -Destination $log1Name
Copy-Item $latestLog2.FullName -Destination $log2Name

Write-Output "Copied logs to the following locations: ",$log1Name,$log2Name

Start "$destPath$logDir"

Set-Location $loc

This will copy the two most recent media log files from the default location where Microsoft Edge ORTC media logs are written into a folder in the home directory of your machine. Copy the entire folder containing these logs and include it in the issue report.

Media logs in Safari

Audio/Video support in Safari is provided by the Skype for Business Meetings Plugin just as in IE, so the Safari plugin media logs are available in a tracing directory within the directory where the plugin is installed, and should have names similar to the plugin media logs in IE.

Media logs in other browsers

Once AV support expands to other browsers like Chrome and Firefox, we will add instructions on capturing media logs for these browsers.